vPenalty.cc

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR is free software: you can redistribute it and/or modify it under the
    terms of the GNU General Public License as published by the Free Software
    Foundation, either version 3 of the License, or (at your option) any later
    version.

    CASToR is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    details.

    You should have received a copy of the GNU General Public License along with
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2019 all CASToR contributors listed below:

    --> Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Thibaut MERLIN, Mael MILLARDET, Simon STUTE, Valentin VIELZEUF

This is CASToR version 3.0.
*/

#include "vPenalty.hh"
#include "sOutputManager.hh"

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================

vPenalty::vPenalty()
{
  // Affect default values
  m_penaltyID = "";
  mp_ImageDimensionsAndQuantification = NULL;
  mp_ImageSpace = NULL;
  m_verbose = 0;
  m_penaltyDerivativesOrder = 0;
  m_penaltyStrength = -1.;
}

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================

vPenalty::~vPenalty()
{
}

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================

void vPenalty::ShowHelp()
{
  // Call the specific help function from the children
  ShowHelpSpecific();
}


// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================

int vPenalty::CheckParameters()
{
  // Check image dimensions
  if (mp_ImageDimensionsAndQuantification==NULL)
  {
    Cerr("***** vPenalty::CheckParameters() -> oImageDimensionsAndQuantification is null !" << endl);
    return 1;
  }
  // Check image space
  if (mp_ImageSpace==NULL)
  {
    Cerr("***** vPenalty::CheckParameters() -> oImageSpace is null !" << endl);
    return 1;
  }
  // Check verbose level
  if (m_verbose<0)
  {
    Cerr("***** vPenalty::CheckParameters() -> Verbose level is negative !" << endl);
    return 1;
  }
  // Check penalty strength
  if (m_penaltyStrength<0.)
  {
    Cerr("***** vPenalty::CheckParameters() -> Penalty strength is negative or unset !" << endl);
    return 1;
  }
  // Call the CheckSpecificParameters function of the child
  if (CheckSpecificParameters())
  {
    Cerr("***** vPenalty::CheckParameters() -> A problem occurred while checking parameters specific to the penalty module !" << endl);
    return 1;
  }
  // Normal end
  return 0;
}

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================

int vPenalty::Initialize()
{
  // Verbose
  if (m_verbose>=VERBOSE_NORMAL)
  {
    Cout("vPenalty::Initialize() -> Initialize the penalty with strength (beta): " << m_penaltyStrength << endl);
  }
  // Call the specific initialization function of the child
  if (InitializeSpecific())
  {
    Cerr("***** vPenalty::Initialize() -> A problem occurred while initializing stuff specific to the optimizer module !" << endl);
    return 1;
  }
  // Normal end
  return 0;
}

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================

int vPenalty::GlobalPreProcessingStep()
{
  // This function from the mother class intentionnaly does nothing so that it can be overloaded
  return 0;
}

// =====================================================================
// ---------------------------------------------------------------------
// ---------------------------------------------------------------------
// =====================================================================

int vPenalty::LocalPreProcessingStep(int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)
{
  // This function from the mother class intentionnaly does nothing so that it can be overloaded
  return 0;
}