MoonIlluminationConstraint¶
-
class
astroplan.MoonIlluminationConstraint(min=None, max=None, ephemeris=None)[source]¶ Bases:
astroplan.ConstraintConstrain the fractional illumination of the Earth’s moon.
Constraint is also satisfied if the Moon has set.
- Parameters
- minfloat or
None(optional) Minimum acceptable fractional illumination (inclusive).
Noneindicates no limit.- maxfloat or
None(optional) Maximum acceptable fractional illumination (inclusive).
Noneindicates no limit.- ephemerisstr, optional
Ephemeris to use. If not given, use the one set with
solar_system_ephemeris(which is set to ‘builtin’ by default).
- minfloat or
Methods Summary
bright([min, max])initialize a
MoonIlluminationConstraintwith defaults of a minimum of 0.65 and no maximumcompute_constraint(times, observer, targets)Actually do the real work of computing the constraint.
dark([min, max])initialize a
MoonIlluminationConstraintwith defaults of no minimum and a maximum of 0.25grey([min, max])initialize a
MoonIlluminationConstraintwith defaults of a minimum of 0.25 and a maximum of 0.65Methods Documentation
-
classmethod
bright(min=0.65, max=None, **kwargs)[source]¶ initialize a
MoonIlluminationConstraintwith defaults of a minimum of 0.65 and no maximum- Parameters
- minfloat or
None(optional) Minimum acceptable fractional illumination (inclusive).
Noneindicates no limit.- maxfloat or
None(optional) Maximum acceptable fractional illumination (inclusive).
Noneindicates no limit.
- minfloat or
-
compute_constraint(times, observer, targets)[source]¶ Actually do the real work of computing the constraint. Subclasses override this.
- Parameters
- Returns
- constraint_result2D array of float or bool
The constraints, with targets along the first index and times along the second.
-
classmethod
dark(min=None, max=0.25, **kwargs)[source]¶ initialize a
MoonIlluminationConstraintwith defaults of no minimum and a maximum of 0.25- Parameters
- minfloat or
None(optional) Minimum acceptable fractional illumination (inclusive).
Noneindicates no limit.- maxfloat or
None(optional) Maximum acceptable fractional illumination (inclusive).
Noneindicates no limit.
- minfloat or
-
classmethod
grey(min=0.25, max=0.65, **kwargs)[source]¶ initialize a
MoonIlluminationConstraintwith defaults of a minimum of 0.25 and a maximum of 0.65- Parameters
- minfloat or
None(optional) Minimum acceptable fractional illumination (inclusive).
Noneindicates no limit.- maxfloat or
None(optional) Maximum acceptable fractional illumination (inclusive).
Noneindicates no limit.
- minfloat or