B q\@sdZddlZddlZddlZddlZddlZddlmZ ddl m Z m Z ddl mZmZddlmZddlmZd d d gZGd d d eZGd d d eeZGdddeZddZdddZddZddZGdd d eZddZdS)z This module defines two classes that deal with parameters. It is unlikely users will need to work with these classes directly, unless they define their own models. N)units)Quantity UnitsError) isiterableOrderedDescriptor)array_repr_oneline)get_inputs_and_params ParameterInputParameterErrorParameterErrorc@seZdZdZdS)r zDGeneric exception class for all exceptions pertaining to Parameters.N)__name__ __module__ __qualname____doc__rr:lib/python3.7/site-packages/astropy/modeling/parameters.pyr sc@seZdZdZdS)r z:Used for incorrect input parameter values and definitions.N)r rrrrrrrr sc@seZdZdZdS)ParameterDefinitionErrorz3Exception in declaration of class-level Parameters.N)r rrrrrrrr$src Cst|rHytj|td}Wqttfk rDtdt|YqXnht |t rTn\t |tj rnt| }nBt |t jtjfrt|}n&t |trtdntdt||S)z+Convert a parameter to float or float array)dtypez0Parameter of {0} could not be converted to floatz7Expected parameter to be of numerical type, not booleanz3Don't know how to convert parameter of {0} to float)rnpZ asanyarrayfloat TypeError ValueErrorr formattype isinstancerZndarrayitemnumbersNumberZnumberbool)valuerrr_tofloat(s(     r!Fcstfdd}|S)NcsJ|jdkrtS|jdk r(t|j|j}n|j}r<||S||SdS)N)_modelNotImplementedunitrr )selfval self_value)op reflectedrrwrapperIs   z-_binary_arithmetic_operation..wrapper) functoolswraps)r(r)r*r)r(r)r_binary_arithmetic_operationHsr-cstfdd}|S)NcsT|jdkr*tjkr&t|j||StS|jdk rDt|j |j}n|j }||S)N) r"operatorltsuper __class____lt__r#r$rr )r%r&r')r(rrr*]s   z-_binary_comparison_operation..wrapper)r+r,)r(r*r)r(r_binary_comparison_operation\sr3cstfdd}|S)Ncs6|jdkrtS|jdk r(t|j|j}n|j}|S)N)r"r#r$rr )r%r')r(rrr*ts   z,_unary_arithmetic_operation..wrapper)r+r,)r(r*r)r(r_unary_arithmetic_operationss r4cseZdZdZdZdZdZdRfdd Zd d Zd d Z ddZ ddZ ddZ ddZ eddZeddZeddZejddZeddZejddZdSd d!Zed"d#Zejd$d#Zed%d&Zed'd(Zed)d*Zejd+d*Zed,d-Zejd.d-Zed/d0Zejd1d0Zed2d3Zejd4d3Zed5d6Zejd7d6Zed8d9Zejd:d9Zed;d<Zejd=d<Zed>d?ZdTd@dAZ edBdCZ!dDdEZ"dFdGZ#dHdIZ$e%dJdKZ&dUdLdMZ'dNdOZ(e)e*j+Z,e)e*j+dPdQZ-e)e*j.Z/e)e*j.dPdQZ0e)e*j1Z2e)e*j1dPdQZ3e)e*j4Z5e)e*j4dPdQZ6e)e*j7Z8e)e*j7dPdQZ9e)e*j7Z:e)e*j7dPdQZ;eet|trl|j|j|jd<n.t|tsZtd|jn|j|j|jd<|j dk r| |||j dk r| |j |}|jdk r|||jj }n||}| ||dS)N orig_unitzeThe '{0}' parameter should be given as a Quantity because it was originally initialized as a Quantity)r!_param_metricsrKrrr$rrr:rIrHrFr _set_model_value)r%rVr Z param_unitrOrrr__set__s"       zParameter.__set__cCs|jdkrtdt|jS)Nz+Parameter definitions do not have a length.)r"rlen)r%rrr__len__8s zParameter.__len__cCs"|j}t|jdkr|g}||S)Nr)r r\r")r%keyr rrr __getitem__=szParameter.__getitem__c Cs|j}t|j}t|trnt||dkr:td|jxhtt | t||D]\}}| ||qTWn6y |||<Wn(t k rtd||j|YnXdS)Nrz;Slice assignment outside the parameter dimensions for '{0}'zBInput dimension {0} invalid for {1!r} parameter with dimension {2}) r r\r"rslicer rrKziprangeindices __setitem__ IndexError)r%r^r Zoldvaluen_modelsidxr&rrrrdEs   " zParameter.__setitem__cCsd|j}|jdkr2|jdk rB|d|j7}n|d|j7}|jdk r\|d|j7}x0|jD]&}t||}|dkrd|d||7}qdWd|jj |S)Nz'{0}'z , default={0}z , value={0}z , unit={0})NF)NNz , {0}={1}z{0}({1})) rr:r"r>r r$ constraintsgetattrr1r )r%argsZconsr&rrr__repr___s      zParameter.__repr__cCs|jS)zParameter name)r:)r%rrrrKsszParameter.namecCs|jdks"|jdks"t|jdkr(|jSt|j}|jj}|j}t|d|dt|}t||}t|d|}tj ||dd}|S)zParameter default valueNr)r)Zaxis) r"r>r\_model_set_axisrshapendimreshapeZrollaxisrepeat)r%rfZmodel_set_axisrMZ new_shaperrrrMys  zParameter.defaultcCs||jdkrtd||j}|jdkr,|S|jj|jd}|jj|jd}|dk rnt||||jS||SdS)z.The unadorned value proxied by this parameter.Nz*Parameter definition does not have a valueraw_unitrX) r"AttributeError_get_model_valuerGrYrKrZfloat64r )r%r rrrXrrrr s   zParameter.valuecCsJ|jdkrtd|jdk r&||}t|tr8td||j|dS)Nz,Cannot set a value on a parameter definitionzThe .value property on parameters should be set to unitless values, not Quantity objects. To set a parameter to a quantity simply set the parameter directly without using .value)r"rsrHrrrrZ)r%r r&rrrr s    cCs,|jdkr|jS|jj|jd|jSdS)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. NrX)r"r?rYrKget)r%rrrr$s zParameter.unitcCs||dS)N) _set_unit)r%r$rrrr$scCsZ|jdkrtd|jj|jd}|r<||jj|jd<n|dkrNtdntddS)Nz)Cannot set unit on a parameter definitionrXzNCannot 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"rsrYrKr)r%r$forcerXrrrrvs  zParameter._set_unitcCs|jdk r|j|jSdSdS)zQ This parameter, as a :class:`~astropy.units.Quantity` instance. N)r$r )r%rrrquantitys  zParameter.quantitycCs.t|tstd|j|_|j|jdddS)Nz:The .quantity attribute should be set to a Quantity objectT)rw)rrrr rvr$)r%rxrrrrxs cCs|jdkrtd|jj|jd}t|jdkr||jj}|dkrlt||}|d|||dd}n||dd}|S)z*The shape of this parameter's value array.Nz+Parameter definition does not have a shape.rnrr)r"rsrYr:r\rm)r%rnZ model_axisrrrrns   zParameter.shapecCs t|jS)z)The size of this parameter's value array.)rsizer )r%rrrry szParameter.sizecCs0|jdk r&|jjd}||j|jS|jSdS)Nr8)r" _constraintsrur:rD)r%r8rrrr8s  zParameter.priorcCs*|jdk r||jjd|j<ntddS)Nr8z3can't set attribute 'prior' on Parameter definition)r"rzr:rs)r%r&rrrr8s cCs0|jdk r&|jjd}||j|jS|jSdS)Nr9)r"rzrur:rC)r%r9rrrr9%s  zParameter.posteriorcCs*|jdk r||jjd|j<ntddS)Nr9z7can't set attribute 'posterior' on Parameter definition)r"rzr:rs)r%r&rrrr9-s cCs0|jdk r&|jjd}||j|jS|jSdS)zS Boolean indicating if the parameter is kept fixed during fitting. Nr5)r"rzrur:r@)r%r5rrrr55s  zParameter.fixedcCs<|jdk r0t|tstd||jjd|j<ntddS)zFix a parameterNzFixed can be True or Falser5z3can't set attribute 'fixed' on Parameter definition)r"rrrrzr:rs)r%r rrrr5As   cCs0|jdk r&|jjd}||j|jS|jSdS)z Indicates that this parameter is linked to another one. A callable which provides the relationship of the two parameters. Nr6)r"rzrur:rA)r%r6rrrr6Ls  zParameter.tiedcCsB|jdk r6t|s"|dkr"td||jjd|j<ntddS)zTie a parameterN)FNzTied must be a callabler6z2can't set attribute 'tied' on Parameter definition)r"callablerrzr:rs)r%r rrrr6Zs  cCs0|jdk r&|jjd}||j|jS|jSdS)z8The minimum and maximum values of a parameter as a tupleNr7)r"rzrur:rB)r%r7rrrr7fs  zParameter.boundscCs|jdk r|\}}|dk r6t|tjs.tdt|}|dk rZt|tjsRtdt|}|jjdi}||f|jjd|j<nt ddS)z>Set the minimum and maximum values of a parameter from a tupleNzMin value must be a numberzMax value must be a numberr7z4can't set attribute 'bounds' on Parameter definition) r"rrrrrrz setdefaultr:rs)r%r Z_minZ_maxr7rrrr7ps   cCs |jdS)z6A value used as a lower bound when fitting a parameterr)r7)r%rrrrPsz Parameter.mincCs$|jdk r||jf|_ntddS)z"Set a minimum value of a parameterNz1can't set attribute 'min' on Parameter definition)r"rQr7rs)r%r rrrrPs cCs |jdS)z7A value used as an upper bound when fitting a parameterr)r7)r%rrrrQsz Parameter.maxcCs$|jdk r|j|f|_ntddS)z#Set a maximum value of a parameter.Nz1can't set attribute 'max' on Parameter definition)r"rPr7rs)r%r rrrrQs cCs2|jdkr|fdd}|Sdd}t||SdS)aA 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). The decorator *returns* the `Parameter` instance that the validator is set on, so the underlying validator method should have the same name as the `Parameter` itself (think of this as analogous to ``property.setter``). For example:: >>> from astropy.modeling import Fittable1DModel >>> class TestModel(Fittable1DModel): ... a = Parameter() ... b = Parameter() ... ... @a.validator ... def a(self, value): ... # Remember, the value can be an array ... if np.any(value < self.b): ... raise InputParameterError( ... "parameter 'a' must be greater than or equal " ... "to parameter 'b'") ... ... @staticmethod ... def evaluate(x, a, b): ... return a * x + b ... >>> m = TestModel(a=1, b=2) # doctest: +IGNORE_EXCEPTION_DETAIL Traceback (most recent call last): ... InputParameterError: parameter 'a' must be greater than or equal to parameter 'b' >>> m = TestModel(a=2, b=2) >>> m.a = 0 # doctest: +IGNORE_EXCEPTION_DETAIL Traceback (most recent call last): ... InputParameterError: parameter 'a' must be greater than or equal to parameter 'b' On bound parameters this property returns the validator method itself, as a bound method on the `Parameter`. This is not often as useful, but it allows validating a parameter value without setting that parameter:: >>> m.a.validator(42) # Passes >>> m.a.validator(-42) # doctest: +IGNORE_EXCEPTION_DETAIL Traceback (most recent call last): ... InputParameterError: parameter 'a' must be greater than or equal to parameter 'b' NcSs ||_|S)N)rI)funcr%rrr validatorsz&Parameter.validator..validatorcSs|jdk r||j|SdS)N)rIr")r%r rrrr~s )r"types MethodType)r%r~rrrr~s :  zParameter.validatorcCst}|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)rPrQ_)localscopyitemshasattrrir1)r%rKrLrMr$rNrOr5r6rPrQr7r8r9kwargsr^r rrrrs    zParameter.copycCs ||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. )rtr")r%rrr _raw_values zParameter._raw_valuecCs*||_||j||_||j||_dS)z Bind the `Parameter` to a specific `Model` instance; don't use this directly on *unbound* parameters, i.e. `Parameter` descriptors that are defined in class bodies. N)r"rFrGrH)r%rRrrrrJ"szParameter._bindcCsVt|dst|j|j|j}|d}|d}|j|}|rJ||}n|d}|S)a? This method implements how to retrieve the value of this parameter from the model instance. See also `Parameter._set_model_value`. These methods take an explicit model argument rather than using self._model so that they can be used from unbound `Parameter` instances. _parametersr`rnr)rrsr:rYrrp)r%rR param_metrics param_slice param_shaper rrrrt0s     zParameter._get_model_valuecCsVdd}|||j|t|drR|j|j\}}t|j|drR||j|||dS)aW This method implements how to store the value of a parameter on the model instance. Currently there is only one storage mechanism (via the ._parameters array) but other mechanisms may be desireable, in which case really the model class itself should dictate this and *not* `Parameter` itself. cSsZ|j|}|d}|d}t|}t||krBtd||t||j|<dS)Nr`rnzTInput value for parameter {0!r} does not have {1} elements as the current value does) rYrZprodryr rZarrayZravelr)rRrKr rrrZ param_sizerrr_update_parameter_valueUs   z;Parameter._set_model_value.._update_parameter_value _param_maprYN)r:rrZ _submodels)r%rRr rZ submodel_indZ param_namerrrrZLs   zParameter._set_model_valuecCst|tjr |jdkrtdn`|dkr,dSt|\}}t|}|dkrJn6|dkrx|dk r|dj}tj |f||i}ntd|S)aMWraps 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 argumentNzIParameter getter/setter must be a function of either one or two arguments) rrZufuncZninrr r\rKr+partial)r*rRZinputsZparamsnargsZ model_argrrrrFhs     zParameter._create_value_wrappercCs.tj|j|d}|jdk r*t||jdd}|S)N)rF)r)rZasarrayr r$r)r%rZarrrrr __array__s zParameter.__array__cCs|jdkrdSt|jSdS)NT)r"rr )r%rrr__bool__s zParameter.__bool__T)r))r;r;NNNNFFNNNNNN)F) NNNNNNFFNNNNN)N)Or rrrrhZ_class_attribute_Z_name_attribute_r<rWr[r]r_rdrkpropertyrKrMr rOr$rvrxrnryr8r9r5r6r7rPrQr~rrrJrtrZ staticmethodrFrrr-r.add__add____radd__sub__sub____rsub__mul__mul____rmul__pow__pow____rpow__truedivZ__div__Z__rdiv__ __truediv__ __rtruediv__r3eq__eq__ne__ne__r/r2gt__gt__le__le__ge__ge__r4neg__neg__abs__abs__ __classcell__rr)r1rr sD 5                J !  $              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. Nz {0} {1!s})rr r$r)Zparamoutrrrparam_repr_onelines  r)F)rr+rrr.ZnumpyrZastropyruZ astropy.unitsrrZ astropy.utilsrrZutilsrr __all__ Exceptionr rr rr!r-r3r4r rrrrrs4     4