U e{j`@sdZddlZddlZddlZddlZddlmZmZddl m Z ddl m Z m Z ddd gZGd d d eZGd ddeeZGd d d eZddZdddZddZddZGdddZddZdS)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 ParameterInputParameterErrorParameterErrorc@seZdZdZdS)r zDGeneric exception class for all exceptions pertaining to Parameters.N__name__ __module__ __qualname____doc__rrZ/var/www/html/bwave/python/venv/lib/python3.8/site-packages/astropy/modeling/parameters.pyr sc@seZdZdZdS)r z:Used for incorrect input parameter values and definitions.Nr rrrrr sc@seZdZdZdS)ParameterDefinitionErrorz3Exception in declaration of class-level Parameters.Nr rrrrr"src Cst|rJztj|td}Wqttfk rFtdt|dYqXntt|t rVnht|tj rpt| }nNt|t j tjfrt|tst|}n(t|trtdntdt|d|S)z+Convert a parameter to float or float arraydtypez 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)rnpZ asanyarrayfloat TypeError ValueErrorr type isinstancerZndarrayitemnumbersNumbernumberbool)valuerrr_tofloat&s*     r!Fcstfdd}|S)Ncs<|jdk rt|j|j}n|j}r.||S||SdSNunitrr selfval self_valueop reflectedrrwrapperIs   z-_binary_arithmetic_operation..wrapper functoolswraps)r*r+r,rr)r_binary_arithmetic_operationHs r0cstfdd}|S)Ncs*|jdk rt|j|j}n|j}||Sr"r#r%r*rrr,Ys z-_binary_comparison_operation..wrapperr-r*r,rr1r_binary_comparison_operationXsr3cstfdd}|S)Ncs(|jdk rt|j|j}n|j}|Sr"r#)r&r(r1rrr,fs z,_unary_arithmetic_operation..wrapperr-r2rr1r_unary_arithmetic_operationesr4cseZdZdZdZdTfdd Zdd Zd d Zd d ZddZ ddZ e ddZ e ddZ e ddZejddZe ddZejddZdUddZe ddZejd dZe d!d"Zejd#d"Ze d$d%Zejd&d%Ze d'd(Ze d)d*Zejd+d*Ze d,d-Zejd.d-Ze d/d0Zejd1d0Ze d2d3Zejd4d3Ze d5d6Zejd7d6Ze d8d9Zejd:d9Ze d;d<Zejd=d<Ze d>d?Zejd@d?Ze dAdBZdCdDZdVdEdFZ e dGdHZ!e!jdIdHZ!e dJdKZ"dLdMZ#dWdNdOZ$dPdQZ%e&e'j(Z)e&e'j(dRdSZ*e&e'j+Z,e&e'j+dRdSZ-e&e'j.Z/e&e'j.dRdSZ0e&e'j1Z2e&e'j1dRdSZ3e&e'j4Z5e&e'j4dRdSZ6e7e'j8Z9e7e'j:Z;e7e'j<Z=e7e'j>Z?e7e'j@ZAe7e'jBZCeDe'jEZFeDe'jGZHZIS)Xraw 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 a function that wraps the raw (internal) value of the parameter when returning the value through the parameter proxy (eg. a parameter may be stored internally as radians but returned to the user as degrees) setter : callable a function that wraps any values assigned to this parameter; should be the inverse of getter 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 )fixedtiedboundsNFcs*td|_d|_||d|_||d|_||_||_ |_ t |t r|dk rz| |jsztd|d||j}|j}||_||_|j|ddd|_|js|jdk r|j|_nd|_| dk r| dk s| dk rtd|n| | f} ||_||_| |_d|_d|_| |_| |_d|_dS)NFzparameter 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_required_create_value_wrapper_setter_getter_namestriprZ _descriptionrrZ is_equivalentr$rr _default_mag _set_unit_internal_unit_valuer_fixed_tied_bounds_order _validator_prior _posterior_std)r&name descriptiondefaultr$gettersetterr5r6minmaxr7prior posteriormag __class__rrr<sH    zParameter.__init__cCs ||_dSr"rB)r&ownerrQrrr __set_name__ szParameter.__set_name__cCs"|j}|jdkrdS|jdSdS)Nrrr)r shaper&r'rrr__len__s zParameter.__len__cCs"|j}t|jdkr|g}||S)Nr)r lenr`)r&keyr rrr __getitem__szParameter.__getitem__c Cs|j}t|trbt||dkr2td|jdtt|t||D]\}}| ||qJnDz |||<Wn6t k rtd|d|jd|j dYnXdS)Nrz7Slice assignment outside the parameter dimensions for ''zInput dimension z invalid for z parameter with dimension ) r rslicercr rQziprangeindices __setitem__ IndexErrorr`)r&rdr Zoldvalueidxr'rrrrks    zParameter.__setitem__cCs~d|jd}|d|j7}|jdk r8|d|j7}|jD]*}t||}|dkr>|d|d|7}q>|jjd|dS) Nrfz, value=z, unit=)NF)NNz, =())rBr r$ constraintsgetattrr\r )r&argsZconsr'rrr__repr__4s   zParameter.__repr__cCs|jS)zParameter namer]r&rrrrQDszParameter.namecCs|jS)zParameter default value)rDrurrrrSJszParameter.defaultcCsp|jdkr |jdkr t|jS|jrBt||j|j|jjS|jrZt||jS|jrlt|jSdS)z.The unadorned value proxied by this parameter.N) rAr@rfloat64rH internal_unit_internal_valuer$r rurrrr Os zParameter.valuecCsLt|trtd|jdkr0tj|tjd|_ntj||tjd|_dS)NzThe .value property on parameters should be set to unitless values, not Quantity objects. To seta parameter to a quantity simply set the parameter directly without using .valuer) rrrr@rarrayrvrHrxr&r rrrr es  cCs|jS)z The unit attached to this parameter, if any. On unbound parameters (i.e. parameters accessed through the model class, rather than a model instance) this is the required/ default unit for the parameter. )_unitrurrrr$ss zParameter.unitcCs |jdkrtdntddS)NzNCannot attach units to parameters that were not initially specified with unitszYCannot change the unit attribute directly, instead change the parameter to a new quantity)r$r)r&r$rrrr$s cCs4|r*t|tr"|js"td|||_n||_dS)Nzt|j}nt|}|dk rt|tjtfsftdt|tr|t|j}nt|}||f|_dS)z>Set the minimum and maximum values of a parameter from a tupleNz(Min value must be a number or a Quantityz(Max value must be a number or a Quantity)rrrrrrr rK)r&r _min_maxrrrr7 s    cCs |jdS)z6A value used as a lower bound when fitting a parameterrr7rurrrrV$sz Parameter.mincCs||jf|_dS)z"Set a minimum value of a parameterN)rWr7rzrrrrV*scCs |jdS)z7A value used as an upper bound when fitting a parameterrrrurrrrW0sz Parameter.maxcCs|j|f|_dS)z#Set a maximum value of a parameter.N)rVr7rzrrrrW6scCs|fdd}|S)aS 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). cSst|r||_|StddS)NzThis decorator method expects a callable. The use of this method as a direct validator is deprecated; use the new validate method instead )rrMr)funcr&rrr validatorJs z&Parameter.validator..validatorr)r&rrrrr<s zParameter.validatorcCs&|jdk r"|jdk r"||j|dS)z#Run the validator on this parameterN)rMr=rzrrrvalidateWszParameter.validatecCs|t}|d=|D]V\}}|dkr|dkr4qn2t||rJt||}nt|d|rft|d|}|||<q|jf|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)rVrW_)localscopyitemshasattrrrr\)r&rQrRrSr$rTrUr5r6rVrWr7rXrYkwargsrdr rrrr\s    zParameter.copycCs|jS)z4Return the model this parameter is associated with.)r=rurrrmodelszParameter.modelcCsJ||_||j||_||j||_|jrF|jdk r@|j|_nd|_dSr")r=r?r@rAr>rDr rHrzrrrrs  cCs|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. )r@rxr rurrr _raw_values zParameter._raw_valuecCst|tjr |jdkrtdnf|dkr,dSt|\}}t|}|dkrJn<|dkr~d|_|dk r|dj}t j |f||i}ntd|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) rrZufuncZninrrrcr>rQr.partial)r&r,rinputsrnargsZ model_argrrrr?s(    zParameter._create_value_wrappercCs0tj|j|d}|jdk r,t||jddd}|S)NrFT)rZsubok)rZasarrayr r$r)r&rZarrrrr __array__s zParameter.__array__cCstt|jSr")rrallr rurrr__bool__szParameter.__bool__T)r+)r8r8NNNNFFNNNNNF)F) NNNNNNFFNNNNN)N)Jr r rrrqr<r_rbrerkrtpropertyrQrSr rUr$rFrwr}r`r~rrXrYr5r6r7rVrWrrrrrr?rrr0operatoradd__add____radd__sub__sub____rsub__mul__mul____rmul__pow__pow____rpow__truediv __truediv__ __rtruediv__r3eq__eq__ne__ne__lt__lt__gt__gt__le__le__ge__ge__r4neg__neg__abs__abs__ __classcell__rrr[rrrsG J                               0   '             cCs(t|j}|jdk r$|d|j}|S)z Like array_repr_oneline but works on `Parameter` objects and supports rendering parameters with units like quantities. N )rr r$)paramoutrrrparam_repr_onelines  r)F)rr.rrnumpyrZ astropy.unitsrrZ astropy.utilsrutilsrr__all__ Exceptionr rr rr!r0r3r4rrrrrrs,  "