a ߙfbuG@sddlZddlmZddlmZgdZGdddZGdddeZ Gd d d eZ Gd d d eZ Gd ddeZ GdddeZ GdddeZddlmZddlmZmZdS)N)units)ShapedLikeNDArray) Attribute TimeAttributeQuantityAttributeEarthLocationAttributeCoordinateAttribute CartesianRepresentationAttributeDifferentialAttributecsHeZdZdZdZdfdd ZddZd d Zdd d Zd dZ Z S)raUA non-mutable data descriptor to hold a frame attribute. This class must be used to define frame attributes (e.g. ``equinox`` or ``obstime``) that are included in a frame class definition. Examples -------- The `~astropy.coordinates.FK4` class uses the following class attributes:: class FK4(BaseCoordinateFrame): equinox = TimeAttribute(default=_EQUINOX_B1950) obstime = TimeAttribute(default=None, secondary_attribute='equinox') This means that ``equinox`` and ``obstime`` are available to be set as keyword arguments when creating an ``FK4`` class instance and are then accessible as instance attributes. The instance value for the attribute must be stored in ``'_' + `` by the frame ``__init__`` method. Note in this example that ``equinox`` and ``obstime`` are time attributes and use the ``TimeAttributeFrame`` class. This subclass overrides the ``convert_input`` method to validate and convert inputs into a ``Time`` object. Parameters ---------- default : object Default value for the attribute if not provided secondary_attribute : str Name of a secondary instance attribute which supplies the value if ``default is None`` and no value was supplied during initialization. z Ncs||_||_tdSN)defaultsecondary_attributesuper__init__)selfr r __class__=lib/python3.9/site-packages/astropy/coordinates/attributes.pyr6szAttribute.__init__cCs ||_dSr )name)rownerrrrr __set_name__;szAttribute.__set_name__cCs|dfS)a Validate the input ``value`` and convert to expected attribute class. The base method here does nothing, but subclasses can implement this as needed. The method should catch any internal exceptions and raise ValueError with an informative message. The method returns the validated input along with a boolean that indicates whether the input value was actually converted. If the input value was already the correct type then the ``converted`` return value should be ``False``. Parameters ---------- value : object Input value to be converted. Returns ------- output_value : object The ``value`` converted to the correct type (or just ``value`` if ``converted`` is False) converted : bool True if the conversion was actually performed, False otherwise. Raises ------ ValueError If the input is not valid for this attribute. Frrvaluerrr convert_input>s zAttribute.convert_inputc Cs|dur|j}n,t|d|j|j}|durtyv}z&td|jd|d|WYd}~n d}~00d }|jrd|_||fS) aU Convert input value to a Time object and validate by running through the Time constructor. Also check that the input was a scalar. Parameters ---------- value : object Input value to be converted. Returns ------- out, converted : correctly-typed object, boolean Tuple consisting of the correctly-typed object and a boolean which indicates if conversion was actually performed. Raises ------ ValueError If the input is not valid for this attribute. r)TimeNNFFzInvalid time input =.T)Z astropy.timer3r! Exceptionr$rrZ writeable)rrr3r(r)errrrrrs$   zTimeAttribute.convert_inputNr.r/r0r1rrrrrrsrcs*eZdZdZdfdd ZddZZS) r a  A frame attribute that is a CartesianRepresentation with specified units. Parameters ---------- default : object Default value for the attribute if not provided secondary_attribute : str Name of a secondary instance attribute which supplies the value if ``default is None`` and no value was supplied during initialization. unit : unit-like or None Name of a unit that the input will be converted into. If None, no unit-checking or conversion is performed Nr cst||||_dSr )rrunit)rr rr:rrrrsz)CartesianRepresentationAttribute.__init__cCst|trJt|dkrJtdd|DrJ|jdurJttd|jdfSt|drj|j j|jkrj|dfSd}t |d|}t|dst d |j j||j}t|dd }||fSdS) a  Checks that the input is a CartesianRepresentation with the correct unit, or the special value ``[0, 0, 0]``. Parameters ---------- value : object Input value to be converted. Returns ------- out : object The correctly-typed object. converted : boolean A boolean which indicates if conversion was actually performed. Raises ------ ValueError If the input is not valid for this attribute. css|]}|dkVqdS)rNr).0vrrr zACartesianRepresentationAttribute.convert_input..NTxyzFr:z;tried to set a {} with something that does not have a unit.copy)r!listlenallr:CartesianRepresentationr"Zzeroshasattrr@r TypeErrorr%rr.to)rrr)Zcartreprrrrs"    z.CartesianRepresentationAttribute.convert_input)Nr Nr.r/r0r1rrr2rrrrr sr cs*eZdZdZdfdd ZddZZS) ra A frame attribute that is a quantity with specified units and shape (optionally). Can be `None`, which should be used for special cases in associated frame transformations like "this quantity should be ignored" or similar. Parameters ---------- default : number or `~astropy.units.Quantity` or None, optional Default value for the attribute if the user does not supply one. If a Quantity, it must be consistent with ``unit``, or if a value, ``unit`` cannot be None. secondary_attribute : str, optional Name of a secondary instance attribute which supplies the value if ``default is None`` and no value was supplied during initialization. unit : unit-like or None, optional Name of a unit that the input will be converted into. If None, no unit-checking or conversion is performed shape : tuple or None, optional If given, specifies the shape the attribute must be Nr csZ|dur|durtd|dur.|dur.|j}||_||_||d}t||dS)NzkEither a default quantity value must be provided, or a unit must be provided to define a QuantityAttribute.r)r$r:rrrr)rr rr:rrrrrszQuantityAttribute.__init__cCs|dur dSt|ds8|jtjkr8t|dkr8td|}tj||jdd}|jdur|j|jkr|jdkr|dkrtj ||jd d }nt d |jd |jd ||u}||fS), Checks that the input is a Quantity with the necessary units (or the special value ``0``). Parameters ---------- value : object Input value to be converted. Returns ------- out, converted : correctly-typed object, boolean Tuple consisting of the correctly-typed object and a boolean which indicates if conversion was actually performed. Raises ------ ValueError If the input is not valid for this attribute. Nr4r:rzJTried to set a QuantityAttribute with something that does not have a unit.FrArTrzThe provided value has shape "z", but should have shape "") rGr:uZdimensionless_unscaledr"anyrHZQuantityrr#r$)rrZoldvaluer)rrrr,s$  zQuantityAttribute.convert_input)Nr NNrJrrrrrs rc@seZdZdZddZdS)ra) A frame attribute that can act as a `~astropy.coordinates.EarthLocation`. It can be created as anything that can be transformed to the `~astropy.coordinates.ITRS` frame, but always presents as an `EarthLocation` when accessed after creation. Parameters ---------- default : object Default value for the attribute if not provided secondary_attribute : str Name of a secondary instance attribute which supplies the value if ``default is None`` and no value was supplied during initialization. cCs\|dur dSt|tr|dfSddlm}t|dsBtd|||}|jdfSdS) rKNr4F)ITRS transform_tozZ"{}" was passed into an EarthLocationAttribute, but it does not have "transform_to" methodT) r! EarthLocationZbuiltin_framesrPrGr$r%rQZearth_location)rrrPZitrsobjrrrris    z$EarthLocationAttribute.convert_inputNr9rrrrrYsrcs*eZdZdZdfdd ZddZZS) ra* A frame attribute which is a coordinate object. It can be given as a `~astropy.coordinates.SkyCoord` or a low-level frame instance. If a low-level frame instance is provided, it will always be upgraded to be a `~astropy.coordinates.SkyCoord` to ensure consistent transformation behavior. The coordinate object will always be returned as a low-level frame instance when accessed. Parameters ---------- frame : `~astropy.coordinates.BaseCoordinateFrame` class The type of frame this attribute can be default : object Default value for the attribute if not provided secondary_attribute : str Name of a secondary instance attribute which supplies the value if ``default is None`` and no value was supplied during initialization. Nr cs||_t||dSr )_framerr)rframer rrrrrszCoordinateAttribute.__init__cCsNddlm}|durdSt||jr,|dfS||}||j}|jdfSdS)a/ Checks that the input is a SkyCoord with the necessary units (or the special value ``None``). Parameters ---------- value : object Input value to be converted. Returns ------- out, converted : correctly-typed object, boolean Tuple consisting of the correctly-typed object and a boolean which indicates if conversion was actually performed. Raises ------ ValueError If the input is not valid for this attribute. r)SkyCoordNr4FT)Zastropy.coordinatesrUr!rSrQrT)rrrUZtransformedobjrrrrs   z!CoordinateAttribute.convert_input)Nr rJrrrrrsrcs*eZdZdZdfdd ZddZZS) r aA frame attribute which is a differential instance. The optional ``allowed_classes`` argument allows specifying a restricted set of valid differential classes to check the input against. Otherwise, any `~astropy.coordinates.BaseDifferential` subclass instance is valid. Parameters ---------- default : object Default value for the attribute if not provided allowed_classes : tuple, optional A list of allowed differential classes for this attribute to have. secondary_attribute : str Name of a secondary instance attribute which supplies the value if ``default is None`` and no value was supplied during initialization. Nr cs,|durt||_nt|_t||dSr )tupleallowed_classesBaseDifferentialrr)rr rWrrrrrs zDifferentialAttribute.__init__cCsR|dur dSt||jsJt|jdkr6|jd|}ntd|j|j|dfS)a Checks that the input is a differential object and is one of the allowed class types. Parameters ---------- value : object Input value. Returns ------- out, converted : correctly-typed object, boolean Tuple consisting of the correctly-typed object and a boolean which indicates if conversion was actually performed. Raises ------ ValueError If the input is not valid for this attribute. Nr4rOrzfTried to set a DifferentialAttribute with an unsupported Differential type {}. Allowed classes are: {}T)r!rWrDrHr%rrrrrrs z#DifferentialAttribute.convert_input)NNr rJrrrrr s  r rO)rR)rFrX)Znumpyr"ZastropyrrMZ astropy.utilsr__all__rrr rrrr ZearthrRZrepresentationrFrXrrrrs  u<BU69C