Observation.hh

Go to the documentation of this file.

/*  HiRISE Observation

PIRL CVS ID: Observation.hh,v 1.50 2020/02/14 01:17:18 schaller Exp

Copyright (C) 2004-2020 Arizona Board of Regents on behalf of the Lunar and
Planetary Laboratory at the University of Arizona.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
*/
#ifndef _HiRISE_Observation_
#define _HiRISE_Observation_

//  UA::HiRISE
#include    "Data_Component.hh"
#include    "MROSP_Header.hh"
#include    "Science_Channel_Header.hh"
#include    "LUT.hh"
#include    "Engineering_Header.hh"
#include    "Image_Line.hh"
#include    "Gap_Map.hh"

#if defined (INCLUDE_PVL)
//  idaeim::PVL
#include    "PVL.hh"
#endif

#include    <iosfwd>
#include    <vector>


namespace UA
{
namespace HiRISE
{
class Observation
    :   public Instrument
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const char
    * const PDS_VERSION_ID,
    * const RECORD_TYPE,
    * const DATA_SET_ID,
    * const DATA_SET_NAME,
    * const PRODUCER_INSTITUTION_NAME,
    * const PRODUCER_ID,
    * const PRODUCER_FULL_NAME,
    * const INSTRUMENT_HOST_NAME,
    * const INSTRUMENT_HOST_ID,
    * const INSTRUMENT_NAME,
    * const INSTRUMENT_ID,
    * const TARGET_NAME,
    * const FLIGHT_SOFTWARE_ID_PREFIX,
    * const PDS_NAMESPACE_PARAMETER_PREFIX;

static const char
    * const DEFAULT_DATA_SET_VERSION;

static const char
    * const DEFAULT_PRODUCT_VERSION;

static const char
    * const NON_PDS_NAMESPACE_PARAMETERS[];

static const int
    MINIMUM_MICROSECONDS_PRECISION;

static const int
    PVL_PDS_BYTES;

/*==============================================================================
    Constructors
*/
Observation ();

explicit Observation (std::istream& stream);

/*==============================================================================
    Accessors
*/
std::string data_ID () const;

std::vector<Data_Component*>& data_components ()
    {return Components;}

unsigned int line_count () const
    {return Line.count ();}

/*==============================================================================
    I/O
*/
std::istream& source () const;

Observation& source (std::istream& stream)
    {Source = &stream; Bytes_Read = 0; return *this;}

bool components ();

unsigned long components (std::ostream& stream) const;

Observation& line ();

std::ostream& line (std::ostream& stream) const;

void reset_line ();

Observation& mirror_channel_1 (bool enable)
    {Mirror_Channel_1 = enable; return *this;}

bool mirror_channel_1 () const
    {return Mirror_Channel_1;}

static void mirror_channel_1_default (bool enable)
    {Mirror_Channel_1_Default = enable;}

static bool mirror_channel_1_default ()
    {return Mirror_Channel_1_Default;}

unsigned long long bytes_read () const
    {return Bytes_Read;}

std::ostream& print
    (std::ostream& stream = std::cout, bool verbose = false) const;

std::string data_set_version () const
    {return Data_Set_Version;}

Observation& data_set_version (const char* version);
    
std::string product_version () const
    {return Product_Version;}

Observation& product_version (const char* version);
    
#if defined (INCLUDE_PVL)
/*==============================================================================
    PVL
*/
idaeim::PVL::Aggregate* PVL () const;

idaeim::PVL::Aggregate* PVL_PDS () const
    {return PVL_PDS (Line);}

idaeim::PVL::Aggregate* PVL_PDS (const Image_Line& image_line) const;

static void gap_map_shift (idaeim::PVL::Parameter* gap_map, int shift);

#endif  // defined (INCLUDE_PVL)

/*------------------------------------------------------------------------------
    Data
*/
//  Data_Component blocks:

MROSP_Header
    MROSP;

Science_Channel_Header
    Science;

LUT
    Lookup_Table;

Engineering_Header
    Engineering;

Image_Line
    Line;

Gap_Map
    Gaps;

std::vector<Data_Component*>
    Components;

/*..............................................................................
    Object management data memembers
*/
private:

std::istream
    *Source;

unsigned long long
    Bytes_Read;

static bool
    Mirror_Channel_1_Default;

bool
    Mirror_Channel_1;

std::string
    Data_Set_Version;

std::string
    Product_Version;

};  //  class Observation

/*==============================================================================
    Helper functions
*/
std::ostream& operator<<
    (std::ostream& stream, const Observation& observation);

}   //  namespace HiRISE
}   //  namespace UA
#endif