org.jactr.tools.itr.ortho
Interface ISliceAnalysis

All Known Implementing Classes:
SliceAnalysis

public interface ISliceAnalysis

container for the analysis of a particular ISlice. Images, detailed reports, and fit statistics can be associated with this analysis. As well as a serializable result for further analysis with respect to the other analyses.

Author:
harrison

Method Summary
 void addDetail(java.lang.String label, java.lang.String workingRelativePath)
          provide the path to an analysis generated file, typically containing additional details labels must be unique
 void addFitStatistics(java.lang.String label, double rmse, double rsquare, long n, boolean flag)
          add common fit statistics
 void addFitStatistics(java.lang.String label, java.util.Map<java.lang.String,java.lang.String> stats, boolean flag)
          general fit statistics
 void addImage(java.lang.String label, java.lang.String workingRelativePath)
          provide the path to an analysis generated image relative to the working directory.
 java.util.Map<java.lang.String,java.lang.String> getDetails()
           
 java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFitStatistics()
           
 java.util.Map<java.lang.String,java.lang.String> getImages()
           
 java.util.Map<java.lang.String,java.lang.String> getModels()
           
 java.lang.String getNotes()
           
 java.lang.Object getResult()
          the result of the the analysis.
 ISlice getSlice()
          associated slice
 java.lang.String getWorkingDirectory()
          where all analysis files should be written this is relative to the working directory of the batch execution
 boolean isFlagged()
           
 void setNotes(java.lang.String notes)
           
 

Method Detail

getSlice

ISlice getSlice()
associated slice

Returns:

getResult

java.lang.Object getResult()
the result of the the analysis. If you want to examine different analyses with respect to each other, assign a result and use the ISliceIntegrator

Returns:

addFitStatistics

void addFitStatistics(java.lang.String label,
                      double rmse,
                      double rsquare,
                      long n,
                      boolean flag)
add common fit statistics

Parameters:
label -
rmse -
rsquare -
n -
flag -

addFitStatistics

void addFitStatistics(java.lang.String label,
                      java.util.Map<java.lang.String,java.lang.String> stats,
                      boolean flag)
general fit statistics

Parameters:
label -
stats -
flag -

getFitStatistics

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFitStatistics()

isFlagged

boolean isFlagged()

getWorkingDirectory

java.lang.String getWorkingDirectory()
where all analysis files should be written this is relative to the working directory of the batch execution


addImage

void addImage(java.lang.String label,
              java.lang.String workingRelativePath)
provide the path to an analysis generated image relative to the working directory. labels must be unique

Parameters:
label -
workingRelativePath -

getImages

java.util.Map<java.lang.String,java.lang.String> getImages()

addDetail

void addDetail(java.lang.String label,
               java.lang.String workingRelativePath)
provide the path to an analysis generated file, typically containing additional details labels must be unique

Parameters:
label -
workingRelativePath -

getDetails

java.util.Map<java.lang.String,java.lang.String> getDetails()

getModels

java.util.Map<java.lang.String,java.lang.String> getModels()

setNotes

void setNotes(java.lang.String notes)

getNotes

java.lang.String getNotes()