LUT.hh

Go to the documentation of this file.

/*  HiRISE LUT (Look-up table)
 
PIRL CVS ID: LUT.hh,v 1.33 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_LUT_
#define _HiRISE_LUT_
 
#include    "Data_Component.hh"
 
#if defined (INCLUDE_PVL)
//  idaeim::PVL
#include    "PVL.hh"
#endif
 
#include    <iostream>
#include    <string>
 
namespace UA
{
namespace HiRISE
{
/*******************************************************************************
    LUT
*/
class LUT
:   public Data_Component
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;
 
static const char* const
    NAME;
 
static const Index
    COMPONENT_BYTES;
 
static const Index
    OFFSETS[];
 
static const Index
    ARRAY_COUNTS[][2];
 
enum LUT_Type
    {
    None,
    Square_Root,
    Linear,
    Stored,
 
    Total_LUT_Types
    };
 
static const char*
    TYPE_NAMES[];
 
static const char* const
    PVL_NODES_NAME;
 
static const char* const
    PVL_PDS_TABLE_NAME;
 
static const double
    DEFAULT_PUKOOL_OFFSET;
 
static const unsigned int
    DEFAULT_WIDTH;
 
/*==============================================================================
    Constructors
*/
LUT ();
 
explicit LUT (std::istream& stream);
 
LUT (const LUT& component, bool data_duplicate = true);
 
LUT& operator= (const LUT& component);
 
/*==============================================================================
    Accessors
*/
std::string id () const;
 
const char* name () const;
 
u_int_8 operator[] (Index index) const;
 
u_int_8& operator[] (Index index);
 
Pixel_type* pukool_table (Pixel_type* maping_table,
    double offset_percentage = DEFAULT_PUKOOL_OFFSET);
 
/*==============================================================================
    Printing
*/
std::ostream& print
    (std::ostream& stream = std::cout, bool verbose = false) const;
 
unsigned int width () const
    {return Width;}
 
LUT& width (unsigned int groups)
    {Width = groups ? groups : DEFAULT_WIDTH; return *this;}
 
#if defined (INCLUDE_PVL)
/*==============================================================================
    PVL
*/
idaeim::PVL::Aggregate* PVL () const;
 
idaeim::PVL::Aggregate* PVL_PDS () const;
 
idaeim::PVL::Aggregate* PVL_description () const;
 
#endif  // defined (INCLUDE_PVL)
 
/*==============================================================================
    Validation
*/
bool is_valid () const;
 
private:
/*------------------------------------------------------------------------------
    Data
*/
unsigned int
    Width;
 
};  //  class LUT
 
/*==============================================================================
    Utility functions
*/
#if defined (INCLUDE_PVL)
Pixel_type* pukool_table (const idaeim::PVL::Value& conversion_table,
    Pixel_type* maping_table,
    double offset_percentage = LUT::DEFAULT_PUKOOL_OFFSET);
 
#endif  // defined (INCLUDE_PVL)
 
}   //  namespace HiRISE
}   //  namespace UA
#endif