- Disentangle masks effect from trigger chamber efficiency estimation.

[u/mrichter/AliRoot.git] / MUON / mapping / AliMpPCB.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.                  *
 **************************************************************************/

// $Id$
// $MpId: AliMpPCB.cxx,v 1.8 2006/05/24 13:58:50 ivana Exp $

#include "AliMpPCB.h"

#include "AliMpMotif.h"
#include "AliMpSlatMotifMap.h"
#include "AliMpMotifPosition.h"
#include "AliMpMotifSpecial.h"
#include "AliMpMotifType.h"
#include "AliLog.h"

#include "Riostream.h"
#include "TList.h"
#include "TObjString.h"
#include "TMath.h"
#include <sstream>

 
//-----------------------------------------------------------------------------
/// \class AliMpPCB
///
/// A PCB for station 3,4 or 5
/// 
/// A PCB is a group of pads having the same size
/// Pads are grouped in motifs, where 1 motif = 1 MANU
///
/// The notion of PCB enveloppe is due to the fact that not all PCBs are
/// "full" of pads, e.g. the rounded or short ones miss some pads,
/// but the enveloppe is a virtual size that should be constant 
/// across the slats, and is 400x400 mm.
/// It's a usefull notion to compute e.g. slat center in a uniform way, 
/// considering that a slat is N PCBs, of the same "virtual" size, that of 
/// the enveloppe.
///
/// \author L. Aphecetche
//-----------------------------------------------------------------------------

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

//_____________________________________________________________________________
AliMpPCB::AliMpPCB() 
: TObject(), 
  fId(""), 
  fPadSizeX(0), 
  fPadSizeY(0), 
  fEnveloppeSizeX(0), 
  fEnveloppeSizeY(0),
  fXoffset(0),
  fActiveXmin(0), 
  fActiveXmax(0),
  fIxmin(99999), 
  fIxmax(0), 
  fIymin(99999), 
  fIymax(0),
  fMotifPositions(),
  fNofPads(0),
  fMotifMap(0)
{
      ///
      /// Default ctor.
      ///
    fMotifPositions.SetOwner(kTRUE);
    AliDebug(1,Form("this=%p",this));
}

//_____________________________________________________________________________
AliMpPCB::AliMpPCB(AliMpSlatMotifMap* motifMap, const char* id, Double_t padSizeX, Double_t padSizeY,
		   Double_t enveloppeSizeX, Double_t enveloppeSizeY)
: TObject(), 
  fId(id), 
  fPadSizeX(padSizeX),
  fPadSizeY(padSizeY), 
  fEnveloppeSizeX(enveloppeSizeX), 
  fEnveloppeSizeY(enveloppeSizeY),
  fXoffset(0),
  fActiveXmin(0), 
  fActiveXmax(0),
  fIxmin(99999), 
  fIxmax(0),
  fIymin(99999), 
  fIymax(0),
  fMotifPositions(),
  fNofPads(0),
  fMotifMap(motifMap)
{
      ///
      /// Normal ctor. Must be fed with the PCB's name (id), the pad dimensions
      /// and the global dimension of the virtual enveloppe of the PCB
      /// (usually 400x400 mm)
    fMotifPositions.SetOwner(kTRUE);
    AliDebug(1,Form("this=%p id=%s",this,id));
}

//_____________________________________________________________________________
AliMpPCB::AliMpPCB(const AliMpPCB& o) 
: TObject(o),
  fId(0),
  fPadSizeX(0), 
  fPadSizeY(0), 
  fEnveloppeSizeX(0),
  fEnveloppeSizeY(0),
  fXoffset(0),
  fActiveXmin(0), 
  fActiveXmax(0),
  fIxmin(99999), 
  fIxmax(0), 
  fIymin(99999), 
  fIymax(0),
  fMotifPositions(),
  fNofPads(0),
  fMotifMap(0x0)
{
  ///
  /// Copy constructor

  fMotifPositions.SetOwner(kTRUE);

  AliDebug(1,Form("this=%p (copy ctor) : begin",this));
  o.Copy(*this);
  AliDebug(1,Form("this=%p (copy ctor) : end",this));
}

//_____________________________________________________________________________
AliMpPCB::AliMpPCB(const char* id, AliMpMotifSpecial* ms)
: TObject(), 
  fId(id), 
  fPadSizeX(-1.0), 
  fPadSizeY(-1.0),
  fEnveloppeSizeX(ms->DimensionX()*2.0),
  fEnveloppeSizeY(ms->DimensionY()*2.0),
  fXoffset(0.0),
  fActiveXmin(0.0),
  fActiveXmax(fEnveloppeSizeX),
  fIxmin(0),
  fIxmax(ms->GetMotifType()->GetNofPadsX()-1),
  fIymin(0),
  fIymax(ms->GetMotifType()->GetNofPadsY()-1),
  fMotifPositions(),
  fNofPads(ms->GetMotifType()->GetNofPads()),
  fMotifMap(0x0)
{
  ///
  /// Very special ctor to be used by trigger stations only (and for a very
  /// specific case).
  ///
  /// Note that in this very case, we only allow one (special) motif per PCB.
  /// This limitation might not be justified, except that it's all we need
  /// so far ;-)
  ///
 
  AliDebug(1,Form("this=%p (ctor special motif)",this));
    
  fMotifPositions.SetOwner(kTRUE);

  Double_t posx = ms->DimensionX();
  Double_t posy = ms->DimensionY();
  AliMpMotifPosition* mp = new AliMpMotifPosition(-1,ms,posx,posy);
  mp->SetLowIndicesLimit(fIxmin,fIymin);
  mp->SetHighIndicesLimit(fIxmax,fIymax);
  fMotifPositions.AddLast(mp);
}

//_____________________________________________________________________________
AliMpPCB&
AliMpPCB::operator=(const AliMpPCB& o)
{
  /// Assignment operator

  AliDebug(1,Form("this=%p (assignment op) : begin",this));
  o.Copy(*this);
  AliDebug(1,Form("this=%p (assignment op) : end",this));
  return *this;  
}

//_____________________________________________________________________________
AliMpPCB::~AliMpPCB()
{
  ///
  /// Dtor.
  ///
  AliDebug(1,Form("this=%p",this));
}

//_____________________________________________________________________________
Double_t
AliMpPCB::ActiveXmin() const
{
  ///
  /// Returns the mininum x for which there is a pad in this PCB.
  /// Different from Xmin only for PCB which are not full of pads.
  ///
  
  return fActiveXmin;
}

//_____________________________________________________________________________
Double_t
AliMpPCB::ActiveXmax() const
{
  ///
  /// Returns the maximum x for which there is a pad in this PCB.
  /// Different from Xmax only for PCB which are not full of pads.
  ///  
  
  return fActiveXmax;
}

//_____________________________________________________________________________
void
AliMpPCB::Add(AliMpMotifType* mt, Int_t ix, Int_t iy)
{
  ///
  /// Add a motif to this PCB. (ix,iy) indicates one corner position of the motif
  /// where the sign of ix and iy is used to indicate which corner is the 
  /// reference (then for values, abs(ix) and abs(iy) are used indeed) :
  ///
  /// (ix>0,iy>0) : bottom-left corner
  /// (ix<0,iy>0) : bottom-right corner
  /// (ix<0,iy<0) : top-right corner
  /// (ix>0,iy<0) : top-left corner.
  
  TString id(Form("%s-%e-%e",mt->GetID().Data(),PadSizeX(),PadSizeY()));

  AliMpVMotif* motif = fMotifMap->FindMotif(id);
  
  if (!motif)
  {
    motif = new AliMpMotif(id,mt,PadSizeX()/2.0,PadSizeY()/2.0);
    AliDebug(1,Form("Adding motif %s to motifMap",id.Data()));
    fMotifMap->AddMotif(motif);
  }
  else
  {
    AliDebug(1,Form("Got motif %s from motifMap",id.Data()));
  }
  
  Double_t posx(0.);
  Double_t posy(0.);
  Int_t ixmin(-1);
  Int_t iymin(-1);
  
  if ( ix >= 0 && iy >= 0 )
  {
    posx = ix*PadSizeX();
    posy = iy*PadSizeY();
    ixmin = ix;
    iymin = iy;
  }
  else
  if ( ix >= 0 && iy < 0 )
  {
    posx = ix*PadSizeX();
    posy = Ymax()+iy*PadSizeY();
    ixmin = ix;
    iymin = TMath::Nint(Ymax()/PadSizeY()) + iy;
  }
  else
  if ( ix < 0 && iy < 0 )
  {
    posx = Xmax()+ix*PadSizeX();
    posy = Ymax()+iy*PadSizeY();
    ixmin = TMath::Nint(Xmax()/PadSizeX()) + ix;
    iymin = TMath::Nint(Ymax()/PadSizeY()) + iy;
  }
  else
  if ( ix < 0 && iy >=0 )
  {
    posx = Xmax()+ix*PadSizeX();
    posy = iy*PadSizeY();
    ixmin = TMath::Nint(Xmax()/PadSizeX()) + ix;
    iymin = iy;
  }

  posx += motif->DimensionX();
  posy += motif->DimensionY();
  AliMpMotifPosition* mp 
    = new AliMpMotifPosition(-1,motif,posx, posy);

  Int_t ixmax = ixmin + mt->GetNofPadsX() - 1;  
  Int_t iymax = iymin + mt->GetNofPadsY() - 1;
  mp->SetLowIndicesLimit(ixmin,iymin);
  mp->SetHighIndicesLimit(ixmax,iymax);

  fMotifPositions.AddLast(mp);

  fIxmin = TMath::Min(fIxmin,ixmin);
  fIxmax = TMath::Max(fIxmax,ixmax);
  fIymin = TMath::Min(fIymin,iymin);
  fIymax = TMath::Max(fIymax,iymax);

  fActiveXmin = fIxmin*PadSizeX();
  fActiveXmax = (fIxmax+1)*PadSizeX();
  fNofPads += mt->GetNofPads();
}

//_____________________________________________________________________________
AliMpArea 
AliMpPCB::Area() const
{
  /// Return the area of this PCB

  return AliMpArea((Xmin()+Xmax())/2.0,DY(), DX(), DY() );
}

//_____________________________________________________________________________
TObject*
AliMpPCB::Clone(const char* /*newname*/) const
{
  ///
  /// Return a full copy of this object.
  ///
  AliDebug(1,"begin");
  TObject* object = new AliMpPCB(*this);
  AliDebug(1,"end");
  return object;
}

//_____________________________________________________________________________
AliMpPCB*
AliMpPCB::Clone(const TArrayI& manuids, Int_t ixOffset, Double_t xOffset) const
{
  ///
  /// Get a full copy of *this, and then apply 2 changes to it :
  ///
  /// a) define the relationship motifType <-> manu id
  /// b) define the x-offset
  /// c) shift ix indices backwards to insure that e.g. the first
  ///    pcb of a slat will start at ix=0 (only relevant for rounded pcbs).
  ///

  AliDebug(1,"begin");
  
  // First get a full clone.
  AliMpPCB* pcb = static_cast<AliMpPCB*>(Clone());

  if ( Int_t(pcb->GetSize()) != manuids.GetSize() )
  {
      AliError(Form("Cannot Clone PCB %s because I do not get the correct number of "
                    "manu ids (got %d, wanted %d)",pcb->GetID(),
                    manuids.GetSize(),pcb->GetSize()));
      return 0;
  }

  MpPair_t shift = AliMp::Pair(-fIxmin+ixOffset,0);

  // Then change the internal MotifPositions wrt manu id
  // and position (offset in x).
  for ( Int_t i = 0; i < pcb->GetSize(); ++i )
    {
      AliMpMotifPosition* mp = pcb->GetMotifPosition(i);
      mp->SetID(manuids[i]);
      Double_t posx = mp->GetPositionX() + xOffset;
      Double_t posy = mp->GetPositionY();
      mp->SetPosition(posx, posy);
      MpPair_t low = mp->GetLowIndicesLimit();
      low += shift;
      mp->SetLowIndicesLimit(low);
      MpPair_t high = mp->GetHighIndicesLimit();
      high += shift;
      mp->SetHighIndicesLimit(high);
    }
  
  pcb->fIxmin += AliMp::PairFirst(shift);
  pcb->fIxmax += AliMp::PairFirst(shift);
  pcb->fXoffset = xOffset;

  pcb->fActiveXmin += xOffset;
  pcb->fActiveXmax += xOffset;

  AliDebug(1,"end");

  return pcb;
}

//_____________________________________________________________________________
void
AliMpPCB::Copy(TObject& o) const
{
  /// Copy *this into o

  AliDebug(1,"begin");
  
  TObject::Copy(o);
  AliMpPCB& pcb = static_cast<AliMpPCB&>(o);
  pcb.fId = fId;
  pcb.fPadSizeX = fPadSizeX;
  pcb.fPadSizeY = fPadSizeY;
  pcb.fEnveloppeSizeX = fEnveloppeSizeX;
  pcb.fEnveloppeSizeY = fEnveloppeSizeY;
  pcb.fXoffset = fXoffset;
  pcb.fIxmin = fIxmin;
  pcb.fIxmax = fIxmax;
  pcb.fIymin = fIymin;
  pcb.fIymax = fIymax;
  pcb.fActiveXmin = fActiveXmin;
  pcb.fActiveXmax = fActiveXmax;

  AliDebug(1,"Deleting pcb.fMotifPositions");
  pcb.fMotifPositions.Delete();
  AliDebug(1,"Deleting pcb.fMotifPositions : done");

  for ( Int_t i = 0; i < fMotifPositions.GetEntriesFast(); ++i )
    {
      AliMpMotifPosition* pos = (AliMpMotifPosition*)fMotifPositions[i];
      AliMpMotifPosition* pcbpos 
        = new AliMpMotifPosition(pos->GetID(), pos->GetMotif(),
                                 pos->GetPositionX(), pos->GetPositionY());
      pcbpos->SetLowIndicesLimit(pos->GetLowIndicesLimit());
      pcbpos->SetHighIndicesLimit(pos->GetHighIndicesLimit());
      pcb.fMotifPositions.AddLast(pcbpos);
    }
    
    pcb.fNofPads = fNofPads;  
  
  pcb.fMotifMap = fMotifMap; // warning : we do share the motifmap.
  
  AliDebug(1,"end");
}

//_____________________________________________________________________________
Double_t
AliMpPCB::ActiveDX() const
{
  ///
  /// Half-length (in x-direction) occupied by pads  
  ///
  
  return GetNofPadsX()*fPadSizeX/2.0;
}

//_____________________________________________________________________________
Double_t
AliMpPCB::DX() const
{
  ///
  /// Half-length (in x-direction) of the PCB.
  /// This length is the one of the virtual enveloppe of the PCB and might
  /// be bigger than the length occupied by pads (e.g. for rounded or short
  /// PCBs).  
  /// See also ActiveDX().
  ///
  
  return fEnveloppeSizeX/2.0;
}

//_____________________________________________________________________________
Double_t
AliMpPCB::ActiveDY() const
{
  ///
  /// Half-length (in y-direction) occupied by pads
  ///
  
  return GetNofPadsY()*fPadSizeY/2.0;
}

//_____________________________________________________________________________
Double_t
AliMpPCB::DY() const
{
  ///
  /// Half-length (in y-direction) of the PCB.
  /// This length is the one of the virtual enveloppe of the PCB and might
  /// be bigger than the length occupied by pads (e.g. for rounded or short
  /// PCBs).
  /// See also ActiveDY().
  ///
  
  return fEnveloppeSizeY/2.0;
}

//_____________________________________________________________________________
AliMpMotifPosition*
AliMpPCB::FindMotifPosition(Int_t ix, Int_t iy) const
{
  ///
  /// Returns the motifPosition located at the position referenced by
  /// integer indices (ix,iy).
  ///
  
  for (Int_t i = 0; i < fMotifPositions.GetEntriesFast(); ++i )
    {
      AliMpMotifPosition* mp = (AliMpMotifPosition*)fMotifPositions[i];
      if ( mp->HasPadByIndices(AliMp::Pair(ix,iy)) )
      {
        return mp;
      }
    }
  return 0;
}

//_____________________________________________________________________________
AliMpMotifPosition*
AliMpPCB::FindMotifPosition(Double_t x, Double_t y) const
{
  ///
  /// Returns the motifPosition located at position (x,y)
  ///
  
  for (Int_t i = 0; i < fMotifPositions.GetEntriesFast(); ++i )
  {
    AliMpMotifPosition* mp = (AliMpMotifPosition*)fMotifPositions[i];
    
    Double_t localPosX = x - mp->GetPositionX(); 
    Double_t localPosY = y - mp->GetPositionY();
    
    MpPair_t localIndices(
      mp->GetMotif()->PadIndicesLocal(localPosX, localPosY));
    
    if ( localIndices >= 0 && 
         mp->GetMotif()->GetMotifType()->HasPadByLocalIndices(localIndices) )
    {
      return mp;
    }
  }
    return 0;
}

//_____________________________________________________________________________
const char*
AliMpPCB::GetID() const
{
  ///
  /// Returns the name of this PCB.
  ///
  
  return fId.Data();
}

//_____________________________________________________________________________
AliMpMotifPosition*
AliMpPCB::GetMotifPosition(Int_t i) const
{
  ///
  /// Get the i-th motifPosition stored in this PCB's internal array.
  ///
  
  if ( i >= fMotifPositions.GetEntriesFast() ) return 0;

  return (AliMpMotifPosition*)fMotifPositions[i];
}

//_____________________________________________________________________________
Int_t
AliMpPCB::GetNofPadsX() const
{
  ///
  /// Returns the number of pads in x-direction.
  ///
  
  return fIxmax-fIxmin+1;
}

//_____________________________________________________________________________
Int_t
AliMpPCB::GetNofPadsY() const
{
  ///
  /// Returns the number of pads in y-direction.
  ///
  
  return fIymax-fIymin+1;
}

//_____________________________________________________________________________
Int_t
AliMpPCB::GetSize() const
{
  ///
  /// Returns the number of motifPositions stored in this PCB.
  ///
  
  return fMotifPositions.GetEntriesFast();
}

//_____________________________________________________________________________
Bool_t 
AliMpPCB::HasMotifPositionID(Int_t manuId) const
{
  /// Returns whether or not we have manuId

  TIter next(&fMotifPositions);
  AliMpMotifPosition* pos;
  while ( ( pos = static_cast<AliMpMotifPosition*>(next()) ) )
  {
    if ( pos->GetID() == manuId ) return kTRUE;
  }
  return kFALSE;
}


//_____________________________________________________________________________
Int_t
AliMpPCB::Ixmin() const
{
  ///
  /// Returns the index value of the leftmost pad.
  ///
  
  return fIxmin;
}

//_____________________________________________________________________________
Int_t
AliMpPCB::Ixmax() const
{
  ///
  /// Returns the index value of the rightmost pad.
  ///
  
  return Ixmin() + GetNofPadsX() - 1;
}

//_____________________________________________________________________________
Int_t
AliMpPCB::Iymin() const
{
  ///
  /// Returns the index value of the bottom pad.
  ///
  
  return fIymin;
}

//_____________________________________________________________________________
Int_t
AliMpPCB::Iymax() const
{
  ///
  /// Returns the index value of the top pad.
  ///
  
  return Iymin() + GetNofPadsY() - 1;
}

//_____________________________________________________________________________
Double_t
AliMpPCB::PadSizeX() const
{
  ///
  /// Returns the pad size in x-direction (in mm)
  ///
  
  return fPadSizeX;
}

//_____________________________________________________________________________
Double_t
AliMpPCB::PadSizeY() const
{
  ///
  /// Returns the pad size in y-direction (in mm)
  ///
  
  return fPadSizeY;
}

//_____________________________________________________________________________
void
AliMpPCB::Print(Option_t* option) const
{
  ///
  /// Printout of this PCB.
  /// If option="M", the contained motifs are printed too.
  ///
  
  cout << "PCB " << GetID() << " PADSIZES=(" << fPadSizeX << ","
  << fPadSizeY << ") iMin=(" << fIxmin << "," << fIymin << ") "
  << "iMax=(" << fIxmax << "," << fIymax << ") " 
  << " EnvXmin,max=(" << Xmin() << "," << Xmax() 
  << ") Xmin,max=(" << ActiveXmin() << "," << ActiveXmax() << ")"
  << endl;
  
  if ( option && option[0] == 'M' )
  {
    for ( Int_t i = 0; i < fMotifPositions.GetEntriesFast(); ++i )
    {
       fMotifPositions[i]->Print(option+1);
    }
  }
}

//_____________________________________________________________________________
void 
AliMpPCB::Save() const
{
  /// 
  /// Save this PCB in the file

  TString fileName(fId);
  fileName += ".pcb";
  TList lines;
  lines.SetOwner(kTRUE);
  
  for ( Int_t i = 0; i < fMotifPositions.GetEntriesFast(); ++i )
  {
    AliMpMotifPosition* pos = GetMotifPosition(i);
    AliMpVMotif* motif = pos->GetMotif();
    
    Double_t lowerLeftX = pos->GetPositionX()-pos->GetDimensionX();
    Double_t lowerLeftY = pos->GetPositionY()-pos->GetDimensionY();
    TString id(motif->GetID());
    // id is supposed to be of the form %s-%e-%e, and we're only
    // interested in the %s part of it
    Ssiz_t index = id.Index("-");
    if ( index < 1 )
    {
      AliError(Form("id=%s does not meet expectations",id.Data()));
      return;
    }
    TString motifName(id(0,index));
    lines.Add(new TObjString(Form("MOTIF %s %d %d",
                                  motifName.Data(),
                                  TMath::Nint(lowerLeftX/fPadSizeX),
                                  TMath::Nint(lowerLeftY/fPadSizeY))));
  }

  ofstream out(fileName.Data());
  out.precision(9);
  out << "SIZES " << fPadSizeX << " " << fPadSizeY
    << " " << fEnveloppeSizeX << " " << fEnveloppeSizeY
    << endl;
  
  TIter next(&lines);
  TObjString* s;
  while ( ( s = (TObjString*)next() ) )
  {
    out << s->String().Data() << endl;
  }
  out.close();
}

//_____________________________________________________________________________
Double_t
AliMpPCB::X() const
{
  ///
  /// Returns the x-position of the PCB center.
  ///
  
  return fXoffset + DX();
}

//_____________________________________________________________________________
Double_t
AliMpPCB::Xmin() const
{
  ///
  /// Returns the leftmost x-position in this PCB.
  ///
  
  return X() - DX();
}

//_____________________________________________________________________________
Double_t
AliMpPCB::Xmax() const
{
  ///
  /// Returns the rightmost x-position in this PCB.
  ///
  
  return X() + DX();
}

//_____________________________________________________________________________
Double_t
AliMpPCB::Y() const
{
  ///
  /// Returns the y-position of the PCB center.
  ///
  
  return DY(); // this works as PCB are organized in a single row within slats.
}

//_____________________________________________________________________________
Double_t
AliMpPCB::Ymin() const
{
  ///
  /// Returns the smallest y-position in this PCB.
  ///
  
  return Y() - DY();
}

//_____________________________________________________________________________
Double_t
AliMpPCB::Ymax() const
{
  ///
  /// Returns the largest y-position in this PCB.
  ///
  
  return Y() + DY();
}