thmvisflat.cpp

Go to the documentation of this file.

#include "Isis.h"
#include "Blob.h"
#include "Cube.h"
#include "CubeAttribute.h"
#include "LineManager.h"
#include "Progress.h"
#include "SpecialPixel.h"

using namespace Isis;
using namespace std;

void IsisMain() {
  UserInterface &ui = Application::GetUserInterface();

  CubeAttributeInput inAtt = ui.GetInputAttribute("FROM");
  Cube icube;

  if(inAtt.Bands().size() != 0) {
    icube.setVirtualBands(inAtt.Bands());
  }

  icube.open(Filename(ui.GetFilename("FROM")).Expanded());

  // Make sure it is a Themis EDR/RDR
  Filename inFilename = ui.GetFilename("FROM");
  try {
    if(icube.getGroup("Instrument")["InstrumentID"][0] != "THEMIS_VIS") {
      string msg = "This program is intended for use on THEMIS VIS images only. [";
      msg += inFilename.Expanded() + "] does not appear to be a THEMIS VIS image.";
      throw iException::Message(iException::User, msg, _FILEINFO_);
    }
  }
  catch(iException &e) {
    string msg = "This program is intended for use on THEMIS VIS images only. [";
    msg += inFilename.Expanded() + "] does not appear to be a THEMIS VIS image.";
    throw iException::Message(iException::User, msg, _FILEINFO_);
  }

  vector<Cube *> flatcubes;
  vector<LineManager *> fcubeMgrs;
  int summing = icube.getGroup("Instrument")["SpatialSumming"][0];

  for(int filt = 0; filt < 5; filt++) {
    string filePattern = "$odyssey/calibration/flat_filter_";
    filePattern += iString(filt + 1) + "_summing_";
    filePattern += iString(summing) + "_v????.cub";
    Filename flatFile(filePattern);
    flatFile.HighestVersion();
    Cube *fcube = new Cube();
    fcube->open(flatFile.Expanded());
    flatcubes.push_back(fcube);

    LineManager *fcubeMgr = new LineManager(*fcube);
    fcubeMgr->SetLine(1, 1);
    fcubeMgrs.push_back(fcubeMgr);
  }

  Cube ocube;

  CubeAttributeOutput outAtt = ui.GetOutputAttribute("TO");
  ocube.setDimensions(icube.getSampleCount(), icube.getLineCount(), icube.getBandCount());
  ocube.setByteOrder(outAtt.ByteOrder());
  ocube.setFormat(outAtt.FileFormat());
  ocube.setLabelsAttached(outAtt.AttachedLabel());
  ocube.setPixelType(outAtt.PixelType());

  ocube.create(Filename(ui.GetFilename("TO")).Expanded());

  LineManager icubeMgr(icube);
  vector<int> filter;

  PvlKeyword &filtNums =
      icube.getLabel()->FindGroup("BandBin", Pvl::Traverse)["FilterNumber"];
  for(int i = 0; i < filtNums.Size(); i++) {
    filter.push_back(filtNums[i]);
  }

  LineManager ocubeMgr(ocube);
  ocubeMgr.SetLine(1, 1);

  Progress prog;
  prog.SetText("Applying Flat-Field Correction");
  prog.SetMaximumSteps(ocube.getLineCount() * ocube.getBandCount());
  prog.CheckStatus();

  do {
    icube.read(icubeMgr);
    ocube.read(ocubeMgr);

    int fcubeIndex = filter[ocubeMgr.Band()-1] - 1;
    flatcubes[fcubeIndex]->read((*fcubeMgrs[fcubeIndex]));

    for(int i = 0; i < ocubeMgr.size(); i++) {
      if(IsSpecial((*fcubeMgrs[fcubeIndex])[i]) || (*fcubeMgrs[fcubeIndex])[i] == 0.0) {
        ocubeMgr[i] = Isis::Null;
      }
      else if(IsSpecial(icubeMgr[i])) {
        ocubeMgr[i] = icubeMgr[i];
      }
      else {
        ocubeMgr[i] = icubeMgr[i] / (*fcubeMgrs[fcubeIndex])[i];
      }
    }

    ocube.write(ocubeMgr);

    icubeMgr++;
    ocubeMgr++;

    for(int i = 0; i < (int)fcubeMgrs.size(); i++) {
      (*fcubeMgrs[i]) ++;

      if(fcubeMgrs[i]->end()) {
        fcubeMgrs[i]->SetLine(1, 1);
      }
    }

    prog.CheckStatus();
  }
  while(!ocubeMgr.end());

  // Propagate labels and objects (in case of spice data)
  PvlObject &inCubeObj = icube.getLabel()->FindObject("IsisCube");
  PvlObject &outCubeObj = ocube.getLabel()->FindObject("IsisCube");

  for(int g = 0; g < inCubeObj.Groups(); g++) {
    outCubeObj.AddGroup(inCubeObj.Group(g));
  }

  for(int o = 0; o < icube.getLabel()->Objects(); o++) {
    if(icube.getLabel()->Object(o).IsNamed("Table")) {
      Blob t(icube.getLabel()->Object(o)["Name"],
             icube.getLabel()->Object(o).Name());
      icube.read(t);
      ocube.write(t);
    }
  }

  icube.close();
  ocube.close();

  for(int i = 0; i < (int)flatcubes.size(); i++) {
    delete fcubeMgrs[i];
    delete flatcubes[i];
  }

  fcubeMgrs.clear();
  flatcubes.clear();
}