doxy: TPC/TPCbase converted

[u/mrichter/AliRoot.git] / TPC / TPCbase / AliTPCInverseCorrection.cxx

/**************************************************************************
 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 *                                                                        *
 * Author: The ALICE Off-line Project.                                    *
 * Contributors are mentioned in the code where appropriate.              *
 *                                                                        *
 * Permission to use, copy, modify and distribute this software and its   *
 * documentation strictly for non-commercial purposes is hereby granted   *
 * without fee, provided that the above copyright notice appears in all   *
 * copies and that both the copyright notice and this permission notice   *
 * appear in the supporting documentation. The authors make no claims     *
 * about the suitability of this software for any purpose. It is          *
 * provided "as is" without express or implied warranty.                  *
 **************************************************************************/

/// \class AliTPCInverseCorrection
/// \brief AliTPCInverseCorrection class
///
/// This is a wrapper that inverts an AliTPCCorrection. This is done by
/// swapping the CalculateCorrection and CalculateInverseCorrection functions.
/// The wrapped correction is supplied as a pointer and the class relies
/// on the fact, that this pointer keeps pointing to the right object.
/// However, the ownership is not changed, i.e. the wrapped correction
/// will not be deleted when this correction is destructed.
///
/// \author Magnus Mager, Stefan Rossegger, Jim Thomas
/// \date 27/04/2010

#include <TString.h>
#include "AliTPCInverseCorrection.h"
#include <TTimeStamp.h>


AliTPCInverseCorrection::AliTPCInverseCorrection()
  : fCorrection(0) {
  /// default constructor
  /// (only meant for ROOT I/O)

}

AliTPCInverseCorrection::AliTPCInverseCorrection(AliTPCCorrection *correction)
  : fCorrection(correction) {
  /// Constructor that is creating the inverse of the supplied correction.
  /// It automatically sets the name ("inv_[correction name]") and tile
  /// ("Inverse of [correction title]").

  TString name,title;
  name  ="inv_";
  name +=correction->GetName();
  title ="Inverse of ";
  title+=correction->GetTitle();
  SetName(name.Data());
  SetTitle(title.Data());
}

AliTPCInverseCorrection::~AliTPCInverseCorrection() {
  /// virtual destructor

  if (fCorrection) delete fCorrection;
}


void AliTPCInverseCorrection::Init() {
  /// Initialization funtion (not used at the moment)

  if (fCorrection) fCorrection->Init();

}

void AliTPCInverseCorrection::Update(const TTimeStamp &timeStamp) {
  /// Update function

  if (fCorrection) fCorrection->Update(timeStamp);

}

void AliTPCInverseCorrection::Print(Option_t* option) const {
  /// Print function to check which correction classes are used
  /// option=="d" prints details regarding the setted magnitude
  /// option=="a" prints the C0 and C1 coefficents for calibration purposes

  printf("Inverse of ");
  if (fCorrection) fCorrection->Print(option);
}

void AliTPCInverseCorrection::GetCorrection(const Float_t x[],const Short_t roc,Float_t dx[]) {
  /// This is just calling the CalculateInverseCorrection of the wrapped
  /// correction -- or puts dr=0 if the latter is 0.

  if (fCorrection)
    fCorrection->GetDistortion(x,roc,dx);
  else
    for (Int_t j=0;j<3;++j) dx[j]=0.;
}

void AliTPCInverseCorrection:: SetOmegaTauT1T2(Float_t omegaTau,Float_t t1,Float_t t2) {
  /// Virtual funtion to pass the wt values (might become event dependent) to the inherited classes
  /// t1 and t2 represent the "effective omegaTau" corrections and were measured in a dedicated
  /// calibration run

  if (fCorrection) fCorrection->SetOmegaTauT1T2(omegaTau, t1, t2);
}

void AliTPCInverseCorrection::GetDistortion(const Float_t x[],const Short_t roc,Float_t dx[]) {
  /// This is just calling the CalculateCorrection of the wrapped
  /// correction -- or puts dr=0 if the latter is 0.

  if (fCorrection)
    fCorrection->GetCorrection(x,roc,dx);
  else
    for (Int_t j=0;j<3;++j) dx[j]=0.;
}

/// \cond CLASSIMP
ClassImp(AliTPCInverseCorrection)
/// \endcond