snappl API

snappl.config Module

Classes

Config([configfile, clone, files_read, ...])	Interface for yaml config file.
NoValue()	Used internally by Config, ignore.
NotFoundValue()	Used internally by Config, ignore.

Class Inheritance Diagram

digraph inheritancec8ab0b9a0e { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Config" [URL="api/snappl.config.Config.html#snappl.config.Config",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Interface for yaml config file."]; "NoValue" [URL="api/snappl.config.NoValue.html#snappl.config.NoValue",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Used internally by Config, ignore."]; "NotFoundValue" [URL="api/snappl.config.NotFoundValue.html#snappl.config.NotFoundValue",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Used internally by Config, ignore."]; }

snappl.dbclient Module

Classes

SNPITDBClient([url, username, password, ...])

A client for communcating with the Roman SNPIT internal database.

Class Inheritance Diagram

digraph inheritance42b23561fd { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "SNPITDBClient" [URL="api/snappl.dbclient.SNPITDBClient.html#snappl.dbclient.SNPITDBClient",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A client for communcating with the Roman SNPIT internal database."]; "rkAuthClient" -> "SNPITDBClient" [arrowsize=0.5,style="setlinewidth(0.5)"]; "rkAuthClient" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; }

snappl.diaobject Module

Classes

DiaObject([id, provenance_id, ra, dec, ...])	Encapsulate a single supernova (or other transient).
DiaObjectOU2024(*args, **kwargs)	A transient from the OpenUniverse 2024 sims.
DiaObjectManual(*args, **kwargs)	A manually-specified object that's not saved anywhere.

Class Inheritance Diagram

digraph inheritance9c90e7ff0c { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "DiaObject" [URL="api/snappl.diaobject.DiaObject.html#snappl.diaobject.DiaObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Encapsulate a single supernova (or other transient)."]; "DiaObjectManual" [URL="api/snappl.diaobject.DiaObjectManual.html#snappl.diaobject.DiaObjectManual",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A manually-specified object that's not saved anywhere."]; "DiaObject" -> "DiaObjectManual" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DiaObjectOU2024" [URL="api/snappl.diaobject.DiaObjectOU2024.html#snappl.diaobject.DiaObjectOU2024",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A transient from the OpenUniverse 2024 sims."]; "DiaObject" -> "DiaObjectOU2024" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

snappl.imagecollection Module

Classes

ImageCollection()	A class that keeps track of groups of images.
ImageCollectionOU2024([base_path])	Collection of OpenUnivers 2024 FITS images.
ImageCollectionManualFITS([base_path, threefile])	Manually specified custom images.
ImageCollectionDB([provenance, base_path])

Class Inheritance Diagram

digraph inheritance5064928408 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ImageCollection" [URL="api/snappl.imagecollection.ImageCollection.html#snappl.imagecollection.ImageCollection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class that keeps track of groups of images."]; "ImageCollectionDB" [URL="api/snappl.imagecollection.ImageCollectionDB.html#snappl.imagecollection.ImageCollectionDB",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ImageCollectionManualFITS" [URL="api/snappl.imagecollection.ImageCollectionManualFITS.html#snappl.imagecollection.ImageCollectionManualFITS",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Manually specified custom images."]; "ImageCollectionOU2024" [URL="api/snappl.imagecollection.ImageCollectionOU2024.html#snappl.imagecollection.ImageCollectionOU2024",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Collection of OpenUnivers 2024 FITS images."]; }

snappl.image Module

Classes

Image([full_filepath, filepath, base_path, ...])	Encapsulates a single 2d image.
Numpy2DImage(*args[, data, noise, flags])	Abstract class for classes that store their array internall as a numpy 2d array.
FITSImage(*args[, noisepath, flagspath, ...])	Base class for classes that read FITS images and uses an AstropyWCS wcs.
FITSImageStdHeaders(*args[, header_kws])	A FITS Image that has standardized header keywords corresponding to the properties defined in Image.
CompressedFITSImage(*args, **kwargs)	An Image which is may correspond to a compressed file on disk (gz or bz2, not yet supporting fpack).
FITSImageOnDisk(*args, **kwargs)	Instantiate an image.
OpenUniverse2024FITSImage(*args[, imagehdu, ...])	Instantiate an image.
RomanDatamodelImage(*args, **kwargs)	An image read from a roman datamodel ASDF file.

Class Inheritance Diagram

digraph inheritance8024593061 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "CompressedFITSImage" [URL="api/snappl.image.CompressedFITSImage.html#snappl.image.CompressedFITSImage",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An Image which is may correspond to a compressed file on disk (gz or bz2, not yet supporting fpack)."]; "FITSImage" -> "CompressedFITSImage" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FITSImage" [URL="api/snappl.image.FITSImage.html#snappl.image.FITSImage",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for classes that read FITS images and uses an AstropyWCS wcs."]; "Numpy2DImage" -> "FITSImage" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FITSImageOnDisk" [URL="api/snappl.image.FITSImageOnDisk.html#snappl.image.FITSImageOnDisk",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "CompressedFITSImage" -> "FITSImageOnDisk" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FITSImageStdHeaders" [URL="api/snappl.image.FITSImageStdHeaders.html#snappl.image.FITSImageStdHeaders",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A FITS Image that has standardized header keywords corresponding to the properties defined in Image."]; "FITSImage" -> "FITSImageStdHeaders" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Image" [URL="api/snappl.image.Image.html#snappl.image.Image",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Encapsulates a single 2d image."]; "PathedObject" -> "Image" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Numpy2DImage" [URL="api/snappl.image.Numpy2DImage.html#snappl.image.Numpy2DImage",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Abstract class for classes that store their array internall as a numpy 2d array."]; "Image" -> "Numpy2DImage" [arrowsize=0.5,style="setlinewidth(0.5)"]; "OpenUniverse2024FITSImage" [URL="api/snappl.image.OpenUniverse2024FITSImage.html#snappl.image.OpenUniverse2024FITSImage",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "CompressedFITSImage" -> "OpenUniverse2024FITSImage" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PathedObject" [URL="api/snappl.pathedobject.PathedObject.html#snappl.pathedobject.PathedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An object that might be stored in the database but that also has files on disk."]; "RomanDatamodelImage" [URL="api/snappl.image.RomanDatamodelImage.html#snappl.image.RomanDatamodelImage",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An image read from a roman datamodel ASDF file."]; "Image" -> "RomanDatamodelImage" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

snappl.image_simulator Module

Classes

ImageSimulatorPointSource([ra, dec])
ImageSimulationStar([mag])
ImageSimulatorStarCollection([ra, dec, ...])
ImageSimulatorTransient([peak_mag, ...])
ImageSimulatorStaticSource(mag, **kwargs)	A class for static sources (galaxies) that don't vary with time.
ImageSimulatorImage([width, height, ra, ...])	NOTE : while working on the image, "noise" is actually variance!!!!
ImageSimulator([seed, star_center, ...])

Class Inheritance Diagram

digraph inheritancea3a0586dd2 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ImageSimulationStar" [URL="api/snappl.image_simulator.ImageSimulationStar.html#snappl.image_simulator.ImageSimulationStar",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ImageSimulatorPointSource" -> "ImageSimulationStar" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ImageSimulator" [URL="api/snappl.image_simulator.ImageSimulator.html#snappl.image_simulator.ImageSimulator",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ImageSimulatorImage" [URL="api/snappl.image_simulator.ImageSimulatorImage.html#snappl.image_simulator.ImageSimulatorImage",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="NOTE : while working on the image, \"noise\" is actually variance!!!!"]; "ImageSimulatorPointSource" [URL="api/snappl.image_simulator.ImageSimulatorPointSource.html#snappl.image_simulator.ImageSimulatorPointSource",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ImageSimulatorStarCollection" [URL="api/snappl.image_simulator.ImageSimulatorStarCollection.html#snappl.image_simulator.ImageSimulatorStarCollection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ImageSimulatorStaticSource" [URL="api/snappl.image_simulator.ImageSimulatorStaticSource.html#snappl.image_simulator.ImageSimulatorStaticSource",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class for static sources (galaxies) that don't vary with time."]; "ImageSimulatorPointSource" -> "ImageSimulatorStaticSource" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ImageSimulatorTransient" [URL="api/snappl.image_simulator.ImageSimulatorTransient.html#snappl.image_simulator.ImageSimulatorTransient",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ImageSimulatorPointSource" -> "ImageSimulatorTransient" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

snappl.lightcurve Module

Classes

DiaObject([id, provenance_id, ra, dec, ...])	Encapsulate a single supernova (or other transient).
Lightcurve([id, data, meta, multiband, ...])	A class to store and save lightcurve data across different SNPIT photometry codes.
Path(*args, **kwargs)	PurePath subclass that can make system calls.
PathedObject([filepath, base_path, ...])	An object that might be stored in the database but that also has files on disk.
Provenance(process, major, minor[, params, ...])	Instantiate a Provenance
QTable([data, masked, names, dtype, meta, ...])	A class to represent tables of heterogeneous data.
SNLogger([midformat, datefmt, ...])	Holds a unified logging instance that can be used throughout SNPIT code.
SNPITDBClient([url, username, password, ...])	A client for communcating with the Roman SNPIT internal database.
SNPITJsonEncoder([skipkeys, ensure_ascii, ...])	Some specific encodings we need for the JSON use.
Table([data, masked, names, dtype, meta, ...])	A class to represent tables of heterogeneous data.

Class Inheritance Diagram

digraph inheritanceeafedbfe20 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Lightcurve" [URL="api/snappl.lightcurve.Lightcurve.html#snappl.lightcurve.Lightcurve",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to store and save lightcurve data across different SNPIT photometry codes."]; "PathedObject" -> "Lightcurve" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PathedObject" [URL="api/snappl.pathedobject.PathedObject.html#snappl.pathedobject.PathedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An object that might be stored in the database but that also has files on disk."]; }

snappl.logger Module

Classes

SNLogger([midformat, datefmt, ...])

Holds a unified logging instance that can be used throughout SNPIT code.

Class Inheritance Diagram

digraph inheritance5a93896e25 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "SNLogger" [URL="api/snappl.logger.SNLogger.html#snappl.logger.SNLogger",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Holds a unified logging instance that can be used throughout SNPIT code."]; }

snappl.pathedobject Module

Classes

Config([configfile, clone, files_read, ...])	Interface for yaml config file.
PathedObject([filepath, base_path, ...])	An object that might be stored in the database but that also has files on disk.

Class Inheritance Diagram

digraph inheritance8d012bf02e { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "PathedObject" [URL="api/snappl.pathedobject.PathedObject.html#snappl.pathedobject.PathedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An object that might be stored in the database but that also has files on disk."]; }

snappl.provenance Module

Classes

Provenance(process, major, minor[, params, ...])

Instantiate a Provenance

Class Inheritance Diagram

digraph inheritance59724cdc4f { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Provenance" [URL="api/snappl.provenance.Provenance.html#snappl.provenance.Provenance",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; }

snappl.psf Module

Classes

PSF([x, y, band, observation_id, sca, ...])	Wraps a PSF.
photutilsImagePSF([peakx, peaky, ...])	Wraps a photutils.psf.ImagePSF.
OversampledImagePSF([oversample_factor, ...])	A PSF stored internally in an image which is (possibly) oversampled.
YamlSerialized_OversampledImagePSF([...])	An OversampledImagePSF with a definfed serialization format.
A25ePSF([_parent_class])	A YamlSerialaled_OversampledImagePSF using the Aldoroty 2025 paper PSF.
ou24PSF_slow([sed, config_file, size, ...])	Wrap the roman_imsim PSFs.
ou24PSF([_parent_class])	Wrap the roman_imsim PSFs, only more efficiently (we hope) than ou24PSF_slow.
STPSF([sed, size, _parent_class])	Wrap the STPSF PSFs.

Class Inheritance Diagram

digraph inheritance4d8e64aefe { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "A25ePSF" [URL="api/snappl.psf.A25ePSF.html#snappl.psf.A25ePSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A YamlSerialaled_OversampledImagePSF using the Aldoroty 2025 paper PSF."]; "YamlSerialized_OversampledImagePSF" -> "A25ePSF" [arrowsize=0.5,style="setlinewidth(0.5)"]; "OversampledImagePSF" [URL="api/snappl.psf.OversampledImagePSF.html#snappl.psf.OversampledImagePSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A PSF stored internally in an image which is (possibly) oversampled."]; "PSF" -> "OversampledImagePSF" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PSF" [URL="api/snappl.psf.PSF.html#snappl.psf.PSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wraps a PSF. All roman snpit photometry code will ideally only use PSF methods defined in this base class."]; "STPSF" [URL="api/snappl.psf.STPSF.html#snappl.psf.STPSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wrap the STPSF PSFs."]; "PSF" -> "STPSF" [arrowsize=0.5,style="setlinewidth(0.5)"]; "YamlSerialized_OversampledImagePSF" [URL="api/snappl.psf.YamlSerialized_OversampledImagePSF.html#snappl.psf.YamlSerialized_OversampledImagePSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An OversampledImagePSF with a definfed serialization format."]; "OversampledImagePSF" -> "YamlSerialized_OversampledImagePSF" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ou24PSF" [URL="api/snappl.psf.ou24PSF.html#snappl.psf.ou24PSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wrap the roman_imsim PSFs, only more efficiently (we hope) than ou24PSF_slow."]; "ou24PSF_slow" -> "ou24PSF" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ou24PSF_slow" [URL="api/snappl.psf.ou24PSF_slow.html#snappl.psf.ou24PSF_slow",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wrap the roman_imsim PSFs."]; "PSF" -> "ou24PSF_slow" [arrowsize=0.5,style="setlinewidth(0.5)"]; "photutilsImagePSF" [URL="api/snappl.psf.photutilsImagePSF.html#snappl.psf.photutilsImagePSF",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wraps a photutils.psf.ImagePSF. Sort of."]; "PSF" -> "photutilsImagePSF" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

snappl.sed Module

Classes

SED_collection(*args, **kwargs)
Flat_SED()
Single_CSV_SED(csv_file[, sed_wave_type, ...])	Initialize the SED collection with a single SED from a CSV file.
OU2024_Truth_SED([snid, isstar])

Class Inheritance Diagram

digraph inheritance849dc4ca68 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Flat_SED" [URL="api/snappl.sed.Flat_SED.html#snappl.sed.Flat_SED",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "SED_collection" -> "Flat_SED" [arrowsize=0.5,style="setlinewidth(0.5)"]; "OU2024_Truth_SED" [URL="api/snappl.sed.OU2024_Truth_SED.html#snappl.sed.OU2024_Truth_SED",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "SED_collection" -> "OU2024_Truth_SED" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SED_collection" [URL="api/snappl.sed.SED_collection.html#snappl.sed.SED_collection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Single_CSV_SED" [URL="api/snappl.sed.Single_CSV_SED.html#snappl.sed.Single_CSV_SED",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "SED_collection" -> "Single_CSV_SED" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

snappl.segmap Module

Classes

SegmentationMap([id, provenance_id, format, ...])

Encapsulate a single segmentation map.

Class Inheritance Diagram

digraph inheritance3b59a31204 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "PathedObject" [URL="api/snappl.pathedobject.PathedObject.html#snappl.pathedobject.PathedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An object that might be stored in the database but that also has files on disk."]; "SegmentationMap" [URL="api/snappl.segmap.SegmentationMap.html#snappl.segmap.SegmentationMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Encapsulate a single segmentation map."]; "PathedObject" -> "SegmentationMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

snappl.spectrum1d Module

Classes

DiaObject([id, provenance_id, ra, dec, ...])	Encapsulate a single supernova (or other transient).
Image([full_filepath, filepath, base_path, ...])	Encapsulates a single 2d image.
PathedObject([filepath, base_path, ...])	An object that might be stored in the database but that also has files on disk.
Provenance(process, major, minor[, params, ...])	Instantiate a Provenance
SNLogger([midformat, datefmt, ...])	Holds a unified logging instance that can be used throughout SNPIT code.
SNPITDBClient([url, username, password, ...])	A client for communcating with the Roman SNPIT internal database.
SNPITJsonEncoder([skipkeys, ensure_ascii, ...])	Some specific encodings we need for the JSON use.
Spectrum1d([id, data_dict, provenance, ...])	A class to store and save single-epoch 1d transient spectra.

Class Inheritance Diagram

digraph inheritance1e2467bb50 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "PathedObject" [URL="api/snappl.pathedobject.PathedObject.html#snappl.pathedobject.PathedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An object that might be stored in the database but that also has files on disk."]; "Spectrum1d" [URL="api/snappl.spectrum1d.Spectrum1d.html#snappl.spectrum1d.Spectrum1d",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to store and save single-epoch 1d transient spectra."]; "PathedObject" -> "Spectrum1d" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

snappl.utils Module

Functions

isSequence(var)	Return True if var is a sequence, but not a string or bytes.
parse_bool(text)	Check if a value represents a boolean value, and return that boolean value if it does.
env_as_bool(varname)	Parse an environment variable as a boolean.
asUUID(id[, oknone])	Pass either a UUID or a string representation of one, get a UUID back.

Classes

SNPITJsonEncoder([skipkeys, ensure_ascii, ...])

Some specific encodings we need for the JSON use.

Class Inheritance Diagram

digraph inheritancef45cd0bc1a { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "JSONEncoder" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Extensible JSON <http://json.org> encoder for Python data structures."]; "SNPITJsonEncoder" [URL="api/snappl.utils.SNPITJsonEncoder.html#snappl.utils.SNPITJsonEncoder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Some specific encodings we need for the JSON use."]; "JSONEncoder" -> "SNPITJsonEncoder" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

snappl.wcs Module

Classes

BaseWCS()	The base class that defines the WCS interface that should be used elsewhere.
AstropyWCS([apwcs])	A WCS that is defined by an astropy.wcs.WCS.
GalsimWCS([gsimwcs])	A WCS speicifc to Galsim.
GWCS([gwcs])	A "G" (Generalized?) WCS : https://gwcs.readthedocs.io/en/latest/

Class Inheritance Diagram

digraph inheritance91e3078249 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AstropyWCS" [URL="api/snappl.wcs.AstropyWCS.html#snappl.wcs.AstropyWCS",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A WCS that is defined by an astropy.wcs.WCS."]; "BaseWCS" -> "AstropyWCS" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseWCS" [URL="api/snappl.wcs.BaseWCS.html#snappl.wcs.BaseWCS",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The base class that defines the WCS interface that should be used elsewhere."]; "GWCS" [URL="api/snappl.wcs.GWCS.html#snappl.wcs.GWCS",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A \"G\" (Generalized?) WCS : https://gwcs.readthedocs.io/en/latest/"]; "BaseWCS" -> "GWCS" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GalsimWCS" [URL="api/snappl.wcs.GalsimWCS.html#snappl.wcs.GalsimWCS",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A WCS speicifc to Galsim."]; "BaseWCS" -> "GalsimWCS" [arrowsize=0.5,style="setlinewidth(0.5)"]; }