B d_@sdZddlZddlZddlZddlZddlmZddlm Z ddl m Z ddl m Z dd d gZ Gd d d eZGd d d eeZGd ddeZddZdddZddZddZGdddZddZdS)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)Quantity) isiterable)array_repr_oneline)get_inputs_and_params ParameterInputParameterErrorParameterErrorc@seZdZdZdS)r zDGeneric exception class for all exceptions pertaining to Parameters.N)__name__ __module__ __qualname____doc__rrh/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/astropy/modeling/parameters.pyr sc@seZdZdZdS)rz:Used for incorrect input parameter values and definitions.N)r r r r rrrrrsc@seZdZdZdS)ParameterDefinitionErrorz3Exception in declaration of class-level Parameters.N)r r r r rrrrr#src Cst|rJytj|td}Wqttfk rFtdt|dYqXnjt|t rVn^t|tj rpt| }nDt|t j tjfrt|}n(t|trtdntdt|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)rnpZ asanyarrayfloat TypeError ValueErrorrtype isinstancerZndarrayitemnumbersNumbernumberbool)valuerrr_tofloat's$    rFcstfdd}|S)Ncs<|jdk rt|j|j}n|j}r.||S||SdS)N)unitrr)selfval self_value)op reflectedrrwrapperFs   z-_binary_arithmetic_operation..wrapper) functoolswraps)r#r$r%r)r#r$r_binary_arithmetic_operationEs r(cstfdd}|S)Ncs*|jdk rt|j|j}n|j}||S)N)rrr)r r!r")r#rrr%Ws z-_binary_comparison_operation..wrapper)r&r')r#r%r)r#r_binary_comparison_operationVs r)cstfdd}|S)Ncs(|jdk rt|j|j}n|j}|S)N)rrr)r r")r#rrr%es z,_unary_arithmetic_operation..wrapper)r&r')r#r%r)r#r_unary_arithmetic_operationds r*c s eZdZdZdZdTfdd 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'j4dRdSZ6e&e'j4Z7e&e'j4dRdSZ8e9e'j:Z;e9e'j<Z=e9e'j>Z?e9e'j@ZAe9e'jBZCe9e'jDZEeFe'jGZHeFe'jIZJZKS)Xra 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 tranforming 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:`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 )fixedtiedboundsNFc std|_d|_||d|_||d|_||_||_ |_ t |t r|dk rv| |jsvtd|||j}|j}||_||_d|_|js|jdk r|j|_nd|_| dk r| dk s| dk rtd|n| | f} ||_||_| |_d|_d|_d|_d|_d|_dS)NFzMparameter default {0} does not have units equivalent to the required unit {1}z]bounds may not be specified simultaneously with min or or max when instantiating Parameter {})super__init___model_model_required_create_value_wrapper_setter_getter_namestripr Z _descriptionrrZ is_equivalentrrformatr_default_unit_internal_unit_valuer_fixed_tied_bounds_order _validator_prior _posterior_std) r name descriptiondefaultrgettersetterr+r,minmaxr-) __class__rrr0sF      zParameter.__init__cCs ||_dS)N)r6)r ownerrErrr __set_name__szParameter.__set_name__cCs"|j}|jdkrdS|jdSdS)Nrrr)rshape)r r!rrr__len__s zParameter.__len__cCs"|j}t|jdkr|g}||S)Nr)rlenrO)r keyrrrr __getitem__szParameter.__getitem__c Cs|j}t|trdt||dkr0td|jxntt| t||D]\}}| ||qJWn)r rrrr,szParameter.tiedcCs"t|s|dkrtd||_dS)zTie a parameter)FNz/Tied must be a callable or set to False or NoneN)callablerr>)r rrrrr,scCs|jS)z8The minimum and maximum values of a parameter as a tuple)r?)r rrrr-szParameter.boundscCs|\}}|dk rFt|tjtfs(tdt|tr>t|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 QuantityzMax value must be a number)rrrrrrrr?)r r_min_maxrrrr-s    cCs |jdS)z6A value used as a lower bound when fitting a parameterr)r-)r rrrrJsz Parameter.mincCs||jf|_dS)z"Set a minimum value of a parameterN)rKr-)r rrrrrJ scCs |jdS)z7A value used as an upper bound when fitting a parameterr)r-)r rrrrKsz Parameter.maxcCs|j|f|_dS)z#Set a maximum value of a parameter.N)rJr-)r rrrrrKscCs|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 )rnrAr)funcr rrr validator-sz&Parameter.validator..validatorr)r rrrrrrrs zParameter.validatorcCs&|jdk r"|jdk r"||j|dS)z$ Run the validator on this parameterN)rAr1)r rrrrvalidate7szParameter.validatecCst}|d=xb|D]V\}}|dkr|dkr6qn2t||rLt||}nt|d|rht|d|}|||<qW|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)rJrK_)localscopyitemshasattrr`rL)r rErFrGrrHrIr+r,rJrKr-rlrmkwargsrRrrrrrv<s    zParameter.copycCs|jS)z5 Return the model this parameter is associated with.)r1)r rrrmodel_szParameter.modelcCsJ||_||j||_||j||_|jrF|jdk r@|j|_nd|_dS)N)r1r3r4r5r2r9rr<)r rrrrrzds  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. )r4rer)r rrr _raw_valueos 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) rrZufuncZninrrrQr2rEr&partial)r r%rzinputsrtnargsZ model_argrrrr3s      zParameter._create_value_wrappercCs.tj|j|d}|jdk r*t||jdd}|S)N)rF)rv)rZasarrayrrr)r rZarrrrr __array__s zParameter.__array__cCs t|jS)N)rr)r rrr__bool__szParameter.__bool__T)r$) r.r.NNNNFFNNN)F) NNNNNNFFNNNNN)N)Lr r r r r_r0rNrPrSrXrbpropertyrErGrrIrrhrdrirOrjrkrlrmr+r,r-rJrKrrrsrvrzr{r3rrr(operatoradd__add____radd__sub__sub____rsub__mul__mul____rmul__pow__pow____rpow__truedivZ__div__Z__rdiv__ __truediv__ __rtruediv__r)eq__eq__ne__ne__lt__lt__gt__gt__le__le__ge__ge__r*neg__neg__abs__abs__ __classcell__rr)rLrrrsD 6                  !  #              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 )rrr)paramoutrrrparam_repr_onelines  r)F)r r&rrnumpyrZ astropy.unitsrZ astropy.utilsrutilsrr__all__ Exceptionr rrrrr(r)r*rrrrrr s,      W