API Reference

sbpy.data

Classes

DataClass()

DataClass serves as the base class for all data container classes in sbpy in order to provide consistent functionality.

Ephem()

Class for querying, manipulating, and calculating ephemerides

Obs()

Class for querying, storing, and manipulating observations

Orbit()

Class for querying, manipulating, integrating, and fitting orbital elements

Phys()

Class for storing and querying physical properties

Names

Class for parsing target identifiers.

Conf

DataClassError

Will be raised in case of exceptions dealing with DataClass.

QueryError

Will be raised in case of query errors.

TimeScaleWarning

Will be raised in case time scales on Time objects have to be converted to comply with query requirements.

sbpy.activity

Classes

Afrho

Coma dust quantity for scattered light.

AnnularAperture(shape)

Annular aperture projected at the distance of the target.

Aperture(dim)

Abstract base class for photometric apertures.

CircularAperture(radius)

Circular aperture projected at the distance of the target.

Efrho

Coma dust quantity for thermal emission.

GaussianAperture([sigma, fwhm])

Gaussian-shaped aperture, e.g., for radio observations.

Haser(Q, v, parent[, daughter])

Haser coma model.

LTE

LTE Methods for calculating production_rate

NonLTE

Class method for non LTE production rate models Not Yet implemented

RectangularAperture(shape)

Rectangular aperture projected at the distance of the target.

Functions

beta_factor(mol_data, ephemobj)

Returns beta factor based on timescales from gas and distance from the Sun using an ephem object.

einstein_coeff(mol_data)

Einstein coefficient from molecular data

fluorescence_band_strength(species[, eph, …])

Fluorescence band strength.

from_Haser(coma, mol_data[, aper])

Calculate production rate for GasComa

intensity_conversion(mol_data)

Returns conversion of the integrated line intensity at 300 K (from the JPL molecular spectra catalog) to a chosen temperature

phase_HalleyMarcus(phase)

Halley-Marcus composite dust phase function.

photo_lengthscale(species[, source])

Photodissociation lengthscale for a gas species.

photo_timescale(species[, source])

Photodissociation timescale for a gas species.

total_number(mol_data, aper, b)

Equation relating number of molecules with column density, the aperture, and geometry given and accounting for photodissociation, derived from data provided.

sbpy.photometry

Classes

DiskIntegratedPhaseFunc(*args[, radius, wfb])

Base class for disk-integrated phase function model

HG(*args, **kwargs)

HG photometric phase model (Bowell et al.

HG12([H, G12])

HG12 photometric phase model (Muinonen et al.

HG12BaseClass(*args, **kwargs)

Base class for IAU HG1G2 model and HG12 model

HG12_Pen16(*args, **kwargs)

Revised H, G12 model by Penttil”a et al.

HG1G2([H, G1, G2])

HG1G2 photometric phase model (Muinonen et al.

LinearPhaseFunc(H, S, **kwargs)

Linear phase function model

NonmonotonicPhaseFunctionWarning

Functions

bandpass(name)

Retrieve bandpass transmission spectrum from sbpy.

Variables

sbpy.spectroscopy

Classes

BlackbodySource([T])

Blackbody sphere.

SpectralGradient

Convert between magnitude and spectral gradient.

SpectralModel

Range of spectral models

Spectrum(flux, dispersionaxis, unit)

sbpy.bib

Classes

Tracking([reporter])

Functions

cite(citations)

Decorator that registers citations within sbpy.

register(task, citations)

Register a citation with the sbpy bibliography tracker.

reset()

Reset sbpy bibliography tracking.

show([filter])

Show current bibliography.

status()

Report sbpy bibliography tracking status.

stop()

Disable sbpy bibliography tracking.

to_aastex([filter])

Convert bibliography to AASTeX format.

to_bibtex([filter])

Convert bibliography to BibTeX format.

to_icarus([filter])

Convert bibliography to Icarus LATeX format.

to_mnras([filter])

Convert bibliography to MNRAS LATeX format.

to_text([filter])

Convert bibcodes to human readable text.

track()

Enable sbpy bibliography tracking.

sbpy.exceptions

Classes

OptionalPackageUnavailable

Optional package is not avilable.

RequiredPackageUnavailable

Required package is not available.

SbpyException

Exception base class for all sbpy exceptions.

SbpyWarning

Warning base class for all sbpy warnings.

sbpy.units

Functions

enable()

Enable sbpy units in the top-level astropy.units namespace.

projected_size(eph)

Angular size and projected linear size equivalency.

reflectance(wfb[, cross_section, reflectance])

Reflectance related equivalencies.

spectral_density_vega(wfb)

Flux density equivalencies with Vega-based magnitude systems.

Variables

JM

Johnson-Morgan magnitude system flux density zeropoint (Johnson et al 1966; Bessell & Murphy 2012).

JMmag

Johnson-Morgan magnitude system: Vega is 0.03 mag at all wavelengths (Johnson et al 1966; Bessell & Murphy 2012).

VEGA

Spectral flux density of Vega.

VEGAmag

Vega-based magnitude: Vega is 0 mag at all wavelengths

hundred_nm

Convenience unit for expressing spectral gradients.

sbpy.utils

Functions