Isis 3.0 Application Source Code Reference

Home

---

cropspecial.cpp

Go to the documentation of this file.

#include "Isis.h"
#include "ProcessByLine.h"
#include "Pixel.h"
#include "LineManager.h"
#include "SpecialPixel.h"
#include "Cube.h"
#include "Table.h"
#include "AlphaCube.h"
#include "Projection.h"
#include "Pvl.h"
#include "PvlKeyword.h"

using namespace std; 
using namespace Isis;

int minSample, maxSample, numSamples;
int minLine, maxLine, numLines;
int curBand, numBands;
bool cropNulls, cropHrs, cropLrs, cropHis, cropLis;
LineManager *in;
Cube cube;

void FindPerimeter (Buffer &in);
void SpecialRemoval (Buffer &out);


void IsisMain() {
  maxSample = 0;
  maxLine = 0;
  curBand = 1;  
  
  // Open the input cube
  UserInterface &ui = Application::GetUserInterface();
  string from = ui.GetAsString("FROM");
  CubeAttributeInput inAtt(from);
  cube.SetVirtualBands(inAtt.Bands());
  from = ui.GetFilename("FROM");
  cube.Open(from);

  cropNulls = ui.GetBoolean("NULL");
  cropHrs = ui.GetBoolean("HRS");
  cropLrs = ui.GetBoolean("LRS");
  cropHis = ui.GetBoolean("HIS");
  cropLis = ui.GetBoolean("LIS");

  minSample = cube.Samples() + 1;
  minLine = cube.Lines() + 1;
  numBands = cube.Bands();
  
  // Setup the input cube
  ProcessByLine p1;
  p1.SetInputCube("FROM");
      
  // Start the first pass
  p1.StartProcess(FindPerimeter);
  p1.EndProcess();

  if (minSample == cube.Samples() + 1) {
    cube.Close();
    string msg = "There are no valid pixels in the [FROM] cube";
    throw iException::Message(iException::User,msg,_FILEINFO_);
  }

  numSamples = maxSample - (minSample - 1);
  numLines = maxLine - (minLine - 1);
  
  // Setup the output cube
  ProcessByLine p2;
  p2.SetInputCube("FROM");
  p2.PropagateTables(false);
  Cube *ocube = p2.SetOutputCube("TO", numSamples, numLines, numBands);
  p2.ClearInputCubes();  
  
  // propagate tables manually
  Pvl &inLabels = *cube.Label();
  
  // Loop through the labels looking for object = Table
  for(int labelObj = 0; labelObj < inLabels.Objects(); labelObj++) {
    PvlObject &obj = inLabels.Object(labelObj);
  
    if(obj.Name() != "Table") continue;
  
    // Read the table into a table object
    Table table(obj["Name"], from);
  
    ocube->Write(table);
  }

  // Construct a label with the results
  PvlGroup results("Results");
  results += PvlKeyword ("InputLines", cube.Lines());
  results += PvlKeyword ("InputSamples", cube.Samples());
  results += PvlKeyword ("StartingLine", minLine);
  results += PvlKeyword ("StartingSample", minSample);
  results += PvlKeyword ("EndingLine", maxLine);
  results += PvlKeyword ("EndingSample", maxSample);
  results += PvlKeyword ("OutputLines", numLines);
  results += PvlKeyword ("OutputSamples", numSamples); 
  
  // Create a buffer for reading the input cube
  in = new LineManager(cube);
  
  // Start the second pass
  p2.StartProcess(SpecialRemoval);

  // Adjust the upper corner x,y values if the cube is projected
  try {
    // Try to create a projection & set the x,y position
    Projection *proj = cube.Projection();
    proj->SetWorld(minSample-0.5,minLine-0.5);

    // Set the new x,y coords in the cube label
    PvlGroup &mapgrp = cube.Label()->FindGroup("Mapping",Pvl::Traverse);
    mapgrp.AddKeyword(PvlKeyword("UpperLeftCornerX",proj->XCoord()), 
                       Pvl::Replace);
    mapgrp.AddKeyword(PvlKeyword("UpperLeftCornerY",proj->YCoord()),
                                      Pvl::Replace);
    ocube->PutGroup(mapgrp);
  }
  // Only write the alpha group if the cube is not projected
  catch (iException &e) {
    // Clear the exception
    e.Clear();

    // Add and/or update the alpha group
    AlphaCube aCube(cube.Samples(),cube.Lines(),
                        ocube->Samples(),ocube->Lines(),
                        minSample-0.5,minLine-0.5,numSamples+0.5,numLines+0.5);
    aCube.UpdateGroup(*ocube->Label());
  }

  p2.EndProcess(); 
  cube.Close();  

  delete in;
  in = NULL;

  // Write the results to the log
  Application::Log(results);
}

// Process each line to find the min and max lines and samples
void FindPerimeter (Buffer &in) {
  for (int i = 0; i < in.size(); i++) {    
    // Do nothing until we find a valid pixel, or a pixel we do not want to crop off
    if ((Pixel::IsValid(in[i])) || (Pixel::IsNull(in[i]) && !cropNulls) || 
        (Pixel::IsHrs(in[i]) && !cropHrs) || (Pixel::IsLrs(in[i]) && !cropLrs) || 
        (Pixel::IsHis(in[i]) && !cropHis) || (Pixel::IsLis(in[i]) && !cropLis)) {
      // The current line has a valid pixel and is greater than max, so make it the new max line
      if (in.Line() > maxLine) maxLine = in.Line();

      // This is the first line to contain a valid pixel, so it's the min line
      if (in.Line() < minLine) minLine = in.Line();      

      int cur_sample = i + 1;

      // We process by line, so the min sample is the valid pixel with the lowest index in all line arrays
      if (cur_sample < minSample) minSample = cur_sample;

      // Conversely, the max sample is the valid pixel with the highest index
      if (cur_sample > maxSample) maxSample = cur_sample;
    }   
  }
}

// Using the min and max values, create a new cube without the extra specials
void SpecialRemoval (Buffer &out) {
  int iline = minLine + (out.Line() - 1);
  in->SetLine(iline, curBand);
  cube.Read(*in);

  // Loop and move appropriate samples
  for (int i = 0; i < out.size(); i++) {
    out[i] = (*in)[(minSample - 1) + i];
  }

  if (out.Line() == numLines) curBand++;
}