IR-efdZddlZddlZddlZddlZddlmZmZddl m Z ddl m Z m Z gdZGdd eZGd d eeZGd d eZdZddZdZdZGddZdZdZdS)z This module defines classes that deal with parameters. It is unlikely users will need to work with these classes directly, unless they define their own models. N)MagUnitQuantity) isiterable)array_repr_onelineget_inputs_and_params) ParameterInputParameterErrorParameterErrorceZdZdZdS)r zDGeneric exception class for all exceptions pertaining to Parameters.N__name__ __module__ __qualname____doc__;lib/python3.11/site-packages/astropy/modeling/parameters.pyr r sNNNNrr ceZdZdZdS)r z:Used for incorrect input parameter values and definitions.Nr rrrr r sDDDDrr ceZdZdZdS)ParameterDefinitionErrorz3Exception in declaration of class-level Parameters.Nr rrrrr"s====rrct|rS tj|t}n#tt f$r!t dt|dwxYwt|trnt|tj r"t| }nt|tj tjfr%t|tst|}nDt|trt dt dt|d|S)z,Convert a parameter to float or float array.dtypez Parameter of z could not be converted to floatz7Expected parameter to be of numerical type, not booleanz'Don't know how to convert parameter of z to float)rnp asanyarrayfloat TypeError ValueErrorr type isinstancerndarrayitemnumbersNumbernumberbool)values r_tofloatr)&sG%  M%u555EE:&   &MU MMM   E8 $ $  E2: & &  ejjll## EGNBI6 7 7  5RV@W@W  e  E4  ! E   " Ld5kk L L L    Ls .2A FcJtjfd}|S)Nc|jt|j|j}n|j}r ||S||SNunitrr()selfval self_valueop reflecteds rwrapperz-_binary_arithmetic_operation..wrapperHsS 9 !$*di88JJJ  '2c:&& &2j#&& &r functoolswraps)r2r3r4s`` r_binary_arithmetic_operationr8Gs>_R ' ' ' ' ' ' NrcFtjfd}|S)Ncn|jt|j|j}n|j}||Sr,r-)r/r0r1r2s rr4z-_binary_comparison_operation..wrapperXs9 9 !$*di88JJJr*c"""rr5r2r4s` r_binary_comparison_operationr<Ws8_R##### NrcFtjfd}|S)Ncl|jt|j|j}n|j}|Sr,r-)r/r1r2s rr4z,_unary_arithmetic_operation..wrapperes5 9 !$*di88JJJr*~~rr5r;s` r_unary_arithmetic_operationr?ds8_R NrcteZdZdZdZ d6fd ZdZdZd Zd Z d Z e d Z e d Z e dZejdZe dZejdZd7dZe dZejdZe dZe dZejdZe dZejdZe dZe dZejdZe dZejdZe dZejd Ze d!Zejd"Ze d#Zejd$Ze d%Zejd&Ze d'Zejd(Ze d)Zejd*Ze d+Zd,Z d8d-Z!e d.Z"e"jd/Z"e d0Z#d1Z$d9d2Z%d3Z&e'e(j)Z*e'e(j)d45Z+e'e(j,Z-e'e(j,d45Z.e'e(j/Z0e'e(j/d45Z1e'e(j2Z3e'e(j2d45Z4e'e(j5Z6e'e(j5d45Z7e8e(j9Z:e8e(j;Z<e8e(j=Z>e8e(j?Z@e8e(jAZBe8e(jCZDeEe(jFZGeEe(jHZIxZJS):r a Wraps individual parameters. Since 4.0 Parameters are no longer descriptors and are based on a new implementation of the Parameter class. Parameters now (as of 4.0) store values locally (as instead previously in the associated model) This class represents a model's parameter (in a somewhat broad sense). It serves a number of purposes: 1) A type to be recognized by models and treated specially at class initialization (i.e., if it is found that there is a class definition of a Parameter, the model initializer makes a copy at the instance level). 2) Managing the handling of allowable parameter values and once defined, ensuring updates are consistent with the Parameter definition. This includes the optional use of units and quantities as well as transforming values to an internally consistent representation (e.g., from degrees to radians through the use of getters and setters). 3) Holding attributes of parameters relevant to fitting, such as whether the parameter may be varied in fitting, or whether there are constraints that must be satisfied. See :ref:`astropy:modeling-parameters` for more details. Parameters ---------- name : str parameter name .. warning:: The fact that `Parameter` accepts ``name`` as an argument is an implementation detail, and should not be used directly. When defining a new `Model` class, parameter names are always automatically defined by the class attribute they're assigned to. description : str parameter description default : float or array default value to use for this parameter unit : `~astropy.units.Unit` if specified, the parameter will be in these units, and when the parameter is updated in future, it should be set to a :class:`~astropy.units.Quantity` that has equivalent units. getter : callable or `None`, optional A function that wraps the raw (internal) value of the parameter when returning the value through the parameter proxy (e.g., a parameter may be stored internally as radians but returned to the user as degrees). The internal value is what is used for computations while the proxy value is what users will interact with (passing and viewing). If ``getter`` is not `None`, then a ``setter`` must also be input. setter : callable or `None`, optional A function that wraps any values assigned to this parameter; should be the inverse of ``getter``. If ``setter`` is not `None`, then a ``getter`` must also be input. fixed : bool if True the parameter is not varied during fitting tied : callable or False if callable is supplied it provides a way to link the value of this parameter to another parameter (or some other arbitrary function) min : float the lower bound of a parameter max : float the upper bound of a parameter bounds : tuple specify min and max as a single tuple--bounds may not be specified simultaneously with min or max mag : bool Specify if the unit of the parameter can be a Magnitude unit or not )fixedtiedboundsNFc:td|_d|_||||t d||d|_||d|_||_| x|_ |_ t|tr?|/||jst!d|d||j}|j}||_||_||dd|_|js|j |j|_nd|_| | | t d|n| | f} ||_||_| |_d|_d|_| |_| |_d|_dS)NFz$setter and getter must both be inputzparameter default z5 does not have units equivalent to the required unit TforcezXbounds may not be specified simultaneously with min or max when instantiating Parameter )super__init___model_model_requiredr_create_value_wrapper_setter_getter_namestripr _descriptionr!r is_equivalentr.rr(_default_mag _set_unit_internal_unit_value_fixed_tied_bounds_order _validator_prior _posterior_std)r/name descriptiondefaultr.gettersetterrArBminmaxrCprior posteriormag __class__s rrIzParameter.__init__s"  $  6>  6>CDD D11&$?? 11&$??  +6+<+<+>+>> t( gx ( ( $(:(:7<(H(H.000)-00|j|jS|j|jSdS)zUnit for the input value.N)rr.rs r input_unitzParameter.input_units+   )% % Y "9 4rc2|jdS|j|jzS)zQ This parameter, as a :class:`~astropy.units.Quantity` instance. N)r.r(rs rquantityzParameter.quantitys 9 4zDI%%rct|tstd|j|_||jddS)Nz:The .quantity attribute should be set to a Quantity objectTrF)r!rrr(rUr.)r/rs rrzParameter.quantitysR(H-- L ^  x}D11111rc@|j |jjS|jjS)z*The shape of this parameter's value array.)rMrWrprrs rrpzParameter.shapes# < ;$ $#))rct|jtjr|dvrt ddS||j_dS)N)r)rz-Cannot assign this shape to a scalar quantity)r!r(rgenericrrprs rrpzParameter.shapesL dj"* - - %J&& !PQQQ'& %DJ   rc4tj|jS)z)The size of this parameter's value array.)rrr(rs rrzParameter.sizeswtz"""rc|jS)z*Standard deviation, if available from fit.r_rs rstdz Parameter.stds yrc||_dSr,rrs rrz Parameter.stds  rc|jSr,r]rs rrgzParameter.priors {rc||_dSr,rrqs rrgzParameter.priors  rc|jSr,r^rs rrhzParameter.posteriors rc||_dSr,rrqs rrhzParameter.posteriors rc|jS)zS Boolean indicating if the parameter is kept fixed during fitting. )rXrs rrAzParameter.fixeds {rc\t|tstd||_dS)zFix a parameter.zValue must be booleanN)r!r'rrXrs rrAzParameter.fixeds0%&& 6455 5 rc|jS)z Indicates that this parameter is linked to another one. A callable which provides the relationship of the two parameters. )rYrs rrBzParameter.tieds zrcXt|s|dvrtd||_dS)zTie a parameter.)FNz/Tied must be a callable or set to False or NoneN)callablerrYrs rrBzParameter.tieds7 O5 #=#=MNN N rc|jS)z9The minimum and maximum values of a parameter as a tuple.)rZrs rrCzParameter.boundss |rc|\}}|it|tjtfst dt|trt |j}nt |}|it|tjtfst dt|trt |j}nt |}||f|_dS)z?Set the minimum and maximum values of a parameter from a tuple.Nz(Min value must be a number or a Quantityz(Max value must be a number or a Quantity)r!r$r%rrrr(rZ)r/r(_min_maxs rrCzParameter.boundss d  dW^X$>?? L JKKK$)) #TZ((T{{  dW^X$>?? L JKKK$)) #TZ((T{{d| rc|jdS)z7A value used as a lower bound when fitting a parameter.rrCrs rrez Parameter.min0{1~rc"||jf|_dS)z#Set a minimum value of a parameter.N)rfrCrs rrez Parameter.min5sdh' rc|jdS)z8A value used as an upper bound when fitting a parameter.rrrs rrfz Parameter.max:rrc"|j|f|_dS)z#Set a maximum value of a parameter.N)rerCrs rrfz Parameter.max?sx' rc|fd}|S)a2 Used as a decorator to set the validator method for a `Parameter`. The validator method validates any value set for that parameter. It takes two arguments--``self``, which refers to the `Model` instance (remember, this is a method defined on a `Model`), and the value being set for this parameter. The validator method's return value is ignored, but it may raise an exception if the value set on the parameter is invalid (typically an `InputParameterError` should be raised, though this is not currently a requirement). Note: Using this method as a decorator will cause problems with pickling the model. An alternative is to assign the actual validator function to ``Parameter._validator`` (see examples in modeling). cPt|r ||_|Std)NzThis decorator method expects a callable. The use of this method as a direct validator is deprecated; use the new validate method instead )rr\r)funcr/s r validatorz&Parameter.validator..validatorVs4~~ "&  Hrr)r/rs rrzParameter.validatorDs#$"&    rc`|j$|j||j|dSdSdS)z$Run the validator on this parameter.N)r\rJrs rvalidatezParameter.validatecs; ? &4;+B OODK / / / / / ' &+B+Brc<t}|d=|D]X\}}|Q|dvr t||rt ||}n&t|d|zrt |d|z}|||<Y|jdi|S)a Make a copy of this `Parameter`, overriding any of its core attributes in the process (or an exact copy). The arguments to this method are the same as those for the `Parameter` initializer. This simply returns a new `Parameter` instance with any or all of the attributes overridden, and so returns the equivalent of: .. code:: python Parameter(self.name, self.description, ...) r/N)rerf_r)localscopyitemshasattrrrj)r/r`rarbr.rcrdrArBrerfrCrgrhkwargsrur(s rrzParameter.copyhs: 6N ,,.. $ $JC}.((tS))9 'c 2 2 sSy119 'cCi 8 8#s t~'''''rc|jS)z4Return the model this parameter is associated with.)rJrs rmodelzParameter.models {rc||_||j||_||j||_|jr|j|j|_dSd|_dSdSr,)rJrLrMrNrKrSr(rWrs rrzParameter.modelsp 11$,FF 11$,FF   #}(!] "  # #rc,|jr|jS|jS)ac Currently for internal use only. Like Parameter.value but does not pass the result through Parameter.getter. By design this should only be used from bound parameters. This will probably be removed are retweaked at some point in the process of rethinking how parameter values are stored/updated. )rMrr(rs r _raw_valuezParameter._raw_values < (' 'zrcdt|tjr)|jdkrt dt |S|dSt |\}}t|}|dkrn@|dkr+d|_|!|dj }tj |fi||i}nt d|S)aLWraps a getter/setter function to support optionally passing in a reference to the model object as the second argument. If a model is tied to this parameter and its getter/setter supports a second argument then this creates a partial function using the model instance as the second argument. rzOA numpy.ufunc used for Parameter getter/setter may only take one input argumentNTzIParameter getter/setter must be a function of either one or two arguments) r!rufuncninr _wrap_ufuncrrtrKr`r6partial)r/r4rinputsrnargs model_args rrLzParameter._create_value_wrappers grx ( ( {a w'' ' _4-g66IFAKKEzz!'+$$!'q I'/NNIu;MNNG5 rcztj|j|}|jt ||jdd}|S)NrFT)rsubok)rasarrayr(r.r)r/rarrs r __array__zParameter.__array__s=j5111 9 3 TBBBC rcNttj|jSr,)r'rallr(rs r__bool__zParameter.__bool__sBF4:&&'''rT)r3)rDrDNNNNFFNNNNNFF) NNNNNNFFNNNNNr,)KrrrrrrIrnrrrvr}rpropertyr`rbr(rdr.rUrrrrprrrgrhrArBrCrerfrrrrrrLrrr8operatoradd__add____radd__sub__sub____rsub__mul__mul____rmul__pow__pow____rpow__truediv __truediv__ __rtruediv__r<eq__eq__ne__ne__lt__lt__gt__gt__le__le__ge__ge__r?neg__neg__abs__abs__ __classcell__)rjs@rr r qsvIIV.K     MMMMMM^   *444 XX!!X!. \ S S\ SX [  [     ##X# ,,,X&&X&_22_2**X*  \%%\%##X#X ZZX \\XX  \\ X [[ X ]$$]$*X Z((Z(X Z((Z(X<000    -(-(-(-(^X \##\#  X &&&P(((+*8<88G++HLDIIIH**8<88G++HLDIIIH**8<88G++HLDIIIH**8<88G++HLDIIIH..x/?@@K//0@DQQQL ) )(+ 6 6F ) )(+ 6 6F ) )(+ 6 6F ) )(+ 6 6F ) )(+ 6 6F ) )(+ 6 6F))(,77G))(,77GGGGGrr cTt|j}|j |d|j}|S)z Like array_repr_oneline but works on `Parameter` objects and supports rendering parameters with units like quantities. N )rr(r.)paramouts rparam_repr_oneliner s5 U[ ) )C z%%uz%% Jrcdfd }|S)NcZ|||zS|||zS|S)z Wrap ufuncs to support passing in units raw_unit is the unit of the value orig_unit is the value after the ufunc has been applied it is assumed ufunc(raw_unit) == orig_unit r)r(raw_unit orig_unitrs r_wrapperz_wrap_ufunc.._wrapper sG  5<<)+ +  !5)** *uU||rrr)rrs` rrr s(       Orr)rr6r$rnumpyr astropy.unitsrr astropy.utilsrutilsrr__all__ Exceptionr rr rr)r8r<r?r r rrrrrs++++++++$$$$$$<<<<<<<< @ @ @OOOOOYOOOEEEEE*nEEE>>>>>~>>>B          K 8K 8K 8K 8K 8K 8K 8K 8\r