ó šßÈ[c@`s~dZddlmZmZmZmZddlZddlZddlZddl Z ddl Z ddl m Zddl mZmZddlmZmZddlmZdd lmZd d lmZd d lmZd ddgZdefd„ƒYZdeefd„ƒYZdefd„ƒYZd„Z e!d„Z"d„Z#d„Z$defd„ƒYZ%d„Z&dS(u¦ 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. i(tabsolute_importtunicode_literalstdivisiontprint_functionNi(tunits(tQuantityt UnitsError(t isiterabletOrderedDescriptor(tsix(tzipi(tarray_repr_oneline(tget_inputs_and_paramsu ParameteruInputParameterErroruParameterErrortParameterErrorcB`seZdZRS(uDGeneric exception class for all exceptions pertaining to Parameters.(t__name__t __module__t__doc__(((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR stInputParameterErrorcB`seZdZRS(u:Used for incorrect input parameter values and definitions.(RRR(((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR$stParameterDefinitionErrorcB`seZdZRS(u3Exception in declaration of class-level Parameters.(RRR(((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR(scC`st|ƒr`ytj|dtjƒ}Wqüttfk r\tdjt|ƒƒƒ‚qüXnœt |t ƒrrnŠt |tj ƒr™t|j ƒƒ}nct |t jtjfƒrÃt|ƒ}n9t |tƒrátdƒ‚ntdjt|ƒƒƒ‚|S(u+Convert a parameter to float or float arraytdtypeu0Parameter of {0} could not be converted to floatu7Expected parameter to be of numerical type, not booleanu3Don't know how to convert parameter of {0} to float(Rtnpt asanyarraytfloatt TypeErrort ValueErrorRtformatttypet isinstanceRtndarraytitemtnumberstNumbertnumbertbool(tvalue((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyt_tofloat,s(  c`s%tjˆƒ‡‡fd†ƒ}|S(Nc`sg|jdkrtS|jdk r:t|j|jƒ}n |j}ˆrVˆ||ƒSˆ||ƒSdS(N(t_modeltNonetNotImplementedtunitRR"(tselftvalt self_value(topt reflected(s:lib/python2.7/site-packages/astropy/modeling/parameters.pytwrapperMs  (t functoolstwraps(R+R,R-((R+R,s:lib/python2.7/site-packages/astropy/modeling/parameters.pyt_binary_arithmetic_operationLs!c`s"tjˆƒ‡fd†ƒ}|S(Nc`s{|jdkr>ˆtjkr7t|j|ƒj|ƒStSn|jdk ret |j |jƒ}n |j }ˆ||ƒS(N( R$R%toperatortlttsupert __class__t__lt__R&R'RR"(R(R)R*(R+(s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR-as (R.R/(R+R-((R+s:lib/python2.7/site-packages/astropy/modeling/parameters.pyt_binary_comparison_operation`sc`s"tjˆƒ‡fd†ƒ}|S(Nc`sM|jdkrtS|jdk r:t|j|jƒ}n |j}ˆ|ƒS(N(R$R%R&R'RR"(R(R*(R+(s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR-xs  (R.R/(R+R-((R+s:lib/python2.7/site-packages/astropy/modeling/parameters.pyt_unary_arithmetic_operationws t Parameterc B`s°eZdZd-ZdZdZddd.d.d.d.eed.d.d.d.d„ Zd„Z d „Z d „Z d „Z d „Z d „Zed„ƒZed„ƒZed„ƒZejd„ƒZed„ƒZejd„ƒZed„Zed„ƒZejd„ƒZed„ƒZed„ƒZed„ƒZejd„ƒZed„ƒZejd„ƒZed„ƒZejd„ƒZed„ƒZejd „ƒZed!„ƒZejd"„ƒZed#„ƒZd.d.d.d.d.d.eed.d.d.d$„ Zed%„ƒZ d&„Z!d'„Z"d(„Z#e$d)„ƒZ%d.d*„Z&d+„Z'e'Z(e)e*j+ƒZ,e)e*j+d,e-ƒZ.e)e*j/ƒZ0e)e*j/d,e-ƒZ1e)e*j2ƒZ3e)e*j2d,e-ƒZ4e)e*j5ƒZ6e)e*j5d,e-ƒZ7e)e*j8ƒZ9e)e*j8d,e-ƒZ:e)e*j8ƒZ;e)e*j8d,e-ƒZ<e=e*j>ƒZ?e=e*j@ƒZAe=e*jBƒZCe=e*jDƒZEe=e*jFƒZGe=e*jHƒZIeJe*jKƒZLeJe*jMƒZNRS(/u Wraps individual parameters. This class represents a model's parameter (in a somewhat broad sense). It acts as both a descriptor that can be assigned to a class attribute to describe the parameters accepted by an individual model (this is called an "unbound parameter"), or it can act as a proxy for the parameter values on an individual model instance (called a "bound parameter"). Parameter instances never store the actual value of the parameter directly. Rather, each instance of a model stores its own parameters parameter values in an array. A *bound* Parameter simply wraps the value in a Parameter proxy which provides some additional information about the parameter such as its constraints. In other words, this is a high-level interface to a model's adjustable parameter values. *Unbound* Parameters are not associated with any specific model instance, and are merely used by model classes to determine the names of their parameters and other information about each parameter such as their default values and default constraints. 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 model : `Model` instance binds the the `Parameter` instance to a specific model upon instantiation; this should only be used internally for creating bound Parameters, and should not be used for `Parameter` descriptors defined as class attributes ufixedutieduboundsu _parameters_u_nameuc C`sytt|ƒjƒ||_|jƒ|_|_| dkrœt|t ƒrœ|dk r‡|j |j ƒ r‡t dj ||ƒƒ‚n|j }|j}n||_||_| dk rí| dk sÒ| dk rùtdj |ƒƒ‚qùn | | f} ||_||_| |_d|_d|_|j|dƒ|_|j|dƒ|_d|_| dk ru|j| ƒndS(NuMparameter default {0} does not have units equivalent to the required unit {1}u^bounds may not be specified simultaneously with min or or max when instantiating Parameter {0}(R3R8t__init__t_nametstripRt _descriptionR%RRt is_equivalentR'RRR"t_defaultt_unitRt_fixedt_tiedt_boundst_orderR$t_create_value_wrappert_gettert_settert _validatort_bind( R(tnamet descriptiontdefaultR'tgettertsettertfixedttiedtmintmaxtboundstmodel((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR9Øs8              cC`sI|dkr|S|jj|jƒ}|jj|jƒ|j|ƒ|S(N(R%R4t__new__t__dict__tupdateRH(R(tobjtobjtypet parameter((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyt__get__s   cC`s*t|ƒ}|j|jd}|dkrXt|tƒr™|j|j|jds  cC`sä|j}t|jƒ}t|tƒr t||ƒdkrXtdj|jƒƒ‚nx…tt |j t|ƒƒŒ|ƒD]\}}|j ||ƒq}Wn@y|||R"R't constraintstgetattrtFalseR4R(R(targstconsR)((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyt__repr__`scC`s|jS(uParameter name(R:(R(((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRItscC`sÉ|jdks3|jdks3t|jƒdkr:|jSt|jƒ}|jj}|j}tj|ƒd|dtj|ƒ}tj||ƒ}tj |d|ƒ}tj ||ddƒ}|S(uParameter default valueiiÿÿÿÿtaxisN(i( R$R%R>R_t_model_set_axisRtshapetndimtreshapetrollaxistrepeat(R(Ritmodel_set_axisRKt new_shape((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRKzs   cC`s­|jdkrtdƒ‚n|j|jƒ}|jdkrC|S|jj|jd}|jj|jd}|dk rœtj|j|||ƒj ƒS|j|ƒSdS(u.The unadorned value proxied by this parameter.u*Parameter definition does not have a valueuraw_unitu orig_unitN( R$R%tAttributeErrort_get_model_valueRER[RIRtfloat64R"(R(R"traw_unitt orig_unit((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR"–s cC`st|jdkrtdƒ‚n|jdk r?|j|ƒ}nt|tƒr]tdƒ‚n|j|j|ƒdS(Nu,Cannot set a value on a parameter definitionu±The .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$R%RzRFRRRR\(R(R"R)((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR"¨scC`s:|jdkr|jS|jj|jjd|jƒSdS(uô 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. u orig_unitN(R$R%R?R[RItget(R(((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR'¸s cC`s|j|ƒdS(N(t _set_unit(R(R'((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyR'ÉscC`s€|jdkrtdƒ‚n|jj|jd}|rU||jj|jdSet the minimum and maximum values of a parameter from a tupleuMin value must be a numberuMax value must be a numberuboundsu4can't set attribute 'bounds' on Parameter definitionN( R$R%RRRRRR†t setdefaultR:Rz(R(R"t_mint_maxRR((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRRIs    cC`s |jdS(u6A value used as a lower bound when fitting a parameteri(RR(R(((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRP_scC`s4|jdk r$||jf|_n tdƒ‚dS(u"Set a minimum value of a parameteru1can't set attribute 'min' on Parameter definitionN(R$R%RQRRRz(R(R"((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRPescC`s |jdS(u7A value used as an upper bound when fitting a parameteri(RR(R(((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRQoscC`s4|jdk r$|j|f|_n tdƒ‚dS(u#Set a maximum value of a parameter.u1can't set attribute 'max' on Parameter definitionN(R$R%RPRRRz(R(R"((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRQuscC`s^|jdkr|d„}|Sd„}tjrJtj||t|ƒƒStj||ƒSdS(uA 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' cS`s ||_|S(N(RG(tfuncR(((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyt validator»s cS`s&|jdk r"|j|j|ƒSdS(N(RGR%R$(R(R"((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRŒÃsN(R$R%R tPY2ttypest MethodTypeR(R(RŒ((s:lib/python2.7/site-packages/astropy/modeling/parameters.pyRŒs:   c C`s¸tƒjƒ} | d=x’tj| ƒD]\} }|dkr&| dkrPq&nJt|| ƒrqt|| ƒ}n)t|d| ƒršt|d| ƒ}n|| | s4"        ÿÿÿ