Package gov.nasa.gsfc.drl.rtstps.core.output.hdf5

This is the core API package for the RDR implementation associated with RT-STPS.

See:
          Description

Interface Summary
PacketFactoryI PacketFactory Interface provides a generic model for making packets that can then tuned for specific needs inside this package.
PacketPool A packet pool manages a pool of packets for reuse.
 

Class Summary
Aggregate Create or read the Aggregrate metadata from an RDR file.
AllData Build the AllData portion of the RDR HDF file structure.
AllDataReader Supports the reading of RDR files /All_Data group using an Iterator.
ApStorageArea Write or read packets from the ApStorageArea area
ATMS_RDR The ATMS specialization of the RDR class which creates the /All_Data/XXX-RDR_All and /Data_Products/XXX-RDR structures.
ATMSRawApplicationPackets Build the RawApplicationPackets (or read a pre-existing one) for the HDF for ATMS.
ATMSRawApplicationPackets2 Build the RawApplicationPackets (or read a pre-existing one) for the HDF for ATMS.
BasicRDR This is the generic RDR processing class, most of the implementation is in abstract RDR class and this just provides the basic counting style RawApplicationPackets class and sets the depth of the count to a specific value.
CalValDomain The CalValDomain is used by the DomainDescription class, CalVals are specified by the mission documentation and have a specific format.
CDSPacketTime A helper class for working with a segmented time of 16 bits of day, 32 bits of milliseconds and 16 bits micros
CommonDataSetObject A common root class for Granule and Aggregate as the both exist in the Data_Product area without any good way to differentiate them ...
CopyPacket Utility class to make a deep copy of a Packet.
CountingRawApplicationPackets Deprecated.
CRIS_RDR The CrIS specialization of the RDR class which creates the /All_Data/XXX-RDR_All and /Data_Products/XXX-RDR structures.
CRISRawApplicationPackets Build CrIS [@link RawApplicationPackets} by capturing groups scan packets between packet with and application ID of 1289.
DataProducts Creates the Data_Products (/Data_Products) area of the HDF data structure in the HDF/RDR file, once created this class has a factory method for creating specific RDRProduct instances.
DataProductsReader Supports the reading of RDR files /Data_Products group using an Iterator.
DomainDescription Creates a domain description from one of three types of domains: Fixed, CalVal or TemporaryAndTest.
FileCreationDateFormat Create proper NPOESS filename CreationDate fields, or parse pre-existing ones back into a Date object.
FilenameTimefieldFormat Enforce certain time field formats for the the RDR filename.
Granule Create Granules in the RDR/HDF file.
GranuleId A Granule identifier is a way of calculating a unique identifier for the IDPS system.
HDF5IO Deprecated.
HDF5Output Deprecated.
HDF5Stats Deprecated.
HDF5Util Provides one method to clean up the HDF5 libs possibly open descriptors.
HDFAttribute Utility class for reading/writing HDF attributes
IETTime Helper class for converting packet times to IETTime which is micros from epoch.
NPOESFilename Deprecated.
NPOESSFilename Creates legal NPOESS (JPSS) filenames.
PacketPoolBySize A very simplistic pooling class for packets for use by the HDF output module only.
PacketPoolHeap This is not a true pool, it gets packets from the heap and gives them back to the heap
PacketPoolOrig A very simplistic pooling class for packets for use by the HDF output module only.
PacketPoolSimple Deprecated.
Packets Use by PacketPool
PacketTrackerItem The packet tracker item is part of the header in the RawApplicationPackets area.
PacketTrackerList Build the packet tracker list in the StaticHeader
PDSDate Manipulate a date given a packet time in the following format, calculate year, day, month, day of year, hour, minute and seconds.
ProductIdentifiersComparator  
RandomAccessPacketFactory A Packet is not created but simply re-used over and over again, although the data is copied into it.
RandomAccessPacketReader Using the StaticHeader of a particular RawApplicationPackets item, read the contents using a random access style interface.
RawApplicationPackets An abstract class to support the creation of a raw application packet dataset in an HDF file for an RDR such as: '/All_Data/VIIRS-SCIENCE-RDR/RawApplicationPackets0' Note that several of these routines must be overridden by the implementation for a specific sensor, and that the original version used a certain algorithm whose vestiges remain in this class.
RawApplicationPacketsFactory Factory style class to build specific RawAppPackets classes such as VIIRSRawApplicationPackets.
RDR The basic guts of building the RDR HDF infrastructure.
RDRAll Create an "XXX-RDR_All" object which is used to write the XXX-RDR_All group in the HDF file
RDRAllReader Iterator for read a specific RDR_All such CrIS-SCIENCE-RDR_All in an HDF file
RDRAppIdItem Read of write the AppIdItem from or to a StaticHeader
RDRAppIdList Create a list of RDRAppIdItems ...
RDRBuilderNPP  
RDRCreateFile Create an HDF file with basics of the RDR structure.
RDRFactory A factory class & method for creating specific RDR based on various input parameters.
RDRFileReader  
RDRFileWriter  
RDROutput  
RDRProduct Create an RDR Product in the /Data_Products and provide methods to write the Aggregate and Granule or it can be used read a pre-existing RDR Product and its Aggregate, and any Granules in it.
ReferenceId A Reference Identifier is defined in the JPSS/NPOESS documentation but is not precise.
SequentialPacketFactory A Packet is not created but simply re-used over and over again, although the data is copied into it.
SequentialPacketReader Using the StaticHeader of a particular RawApplicationPackets item, read the contents using a sequential access style interface.
SpacecraftDiaryRawApplicationPackets Implements the SpacecraftDiary RawApplication area which is a special case of most of the other sensors supported by this package.
SpacecraftDiaryRawApplicationPackets2  
SpacecraftDiaryRDR Deprecated.
SpacecraftDiaryRDR2 The ATMS specialization of the RDR class which creates the /All_Data/XXX-RDR_All and /Data_Products/XXX-RDR structures.
StaticHeader Implements the StaticHeader for the RawApplication area, this class can be used to either create the StaticHeader or read a pre-existing StaticHeader.
Stats  
TemporaryAndTestDomain The Temporary and Test Domain is part of Domain description (@link DomainDescription}.
TimeFormat Provides parse or format methods for certain time field attributes such as Granule's N_CreationTime field.
TimeManagedPacketList The time managed list takes any number of packets as input.
TimeSpanPacketList A helper class for the TimeManagedPacketList, this marks the list of designated packets as either open on front or beginning, open at the end, or complete enclosed or encapsulated or open both on the front and end.
UserBlock Create the user block for the RDR file.
UserBlockReader  
VIIRS_RDR The VIIRS specialization of the RDR class which creates the /All_Data/XXX-RDR_All and /Data_Products/XXX-RDR structures.
VIIRSRawApplicationPackets Implements an algorithm for collecting VIIRS segmented or group packets into a cohesive unit so that blocks of them maybe written atomically into the RawApplicationPackets area for a VIIRS RDR file.
VIIRSSciencePacket Support some aspects of a VIIRS Science Packet, mainly helper method(s) used in VIIRSRawApplicationPackets class to determine the scan number of the VIIRS packets being processed.
WeightedRDRList The list of active RDRs which various access functions.
 

Enum Summary
ATMSScanState An enumeration used by the ATMSRawApplication class
Collection A Collection is defined by the JPSS/NPOESS documentation for RDRs.
DataSetType The valid JPSS data set types, only RDR is supported by this package
FixedDomainDescription Domains as specified by the JPSS specification with the sole exception of drl which is a local edition.
LEOAFlag The LEOAFlag -- on or off
MissionName Official mission names
Origin The Origin is defined according to the JPSS/NPOESS specifications.
PacketName The following table is used by this package to determine which packets it recieves are going to processed.
PlatformShortName Official designation of the platform shortname
ProductIdentifiers ProductionIdentfiers the "field terminal" supports only
RDRName Currently defined RDR, note that only some of these are actually supposed by having corresponding concrete RDR.
Sensor A Sensor is defined by the JPSS/NPOESS documentation.
SpacecraftId The spacecraft identifier is defined by the JPSS/NPOESS specification
StartStopFieldId The start/stop field is part of the NPOESS/JPSS filename
TimeSpanType This is used with the Spacecraft Diary calculation to mark List as being in one of four states in relations the beginning and ending times requested.
TypeID Specified by the JPSS/NPOESS documentation.
 

Exception Summary
RtStpsRuntimeException Local customization of the RuntimeException mainly used in places the checked RtStpsException is not allowed (such as Iterator).
 

Package gov.nasa.gsfc.drl.rtstps.core.output.hdf5 Description

This is the core API package for the RDR implementation associated with RT-STPS. It currently supports three sensors: VIIRS, ATMS and CrIS, and the Spacecraft Diary from the attitude and ephemeris packet.

Since:
0.1