Package gov.nih.mipav.view.dialogs

Interface ActionDiscovery

All Known Implementing Classes:

JDialog3DMosaicTo4DSlices, JDialogAdaptiveKuwaharaFilter, JDialogAGCIE, JDialogAHE, JDialogAHElocal, JDialogAINDANE, JDialogAnisotropicDiffusion, JDialogAntigradient2, JDialogAutoCorrelation, JDialogAutoCovariance, JDialogAutoSeedWatershed, JDialogBGAndFGDistanceMap, JDialogBGDistanceMap, JDialogBilateralFilter, JDialogBM3D, JDialogBorderClearing, JDialogBottomHat, JDialogBrainSurfaceExtractor, JDialogBRISK, JDialogCannyEdgeDetection, JDialogClose, JDialogCoherenceEnhancingDiffusion, JDialogConcat, JDialogContrastEnhancementUsingExposureFusion, JDialogConvergenceField, JDialogConvert3Dto4D, JDialogConvert4Dto3D, JDialogCropBoundaryParam, JDialogCropPointParam, JDialogCyclicPermutation, JDialogDBSCANClusteringSegment, JDialogDeconvolution, JDialogDeleteObjects, JDialogDemonsLite, JDialogDilate, JDialogDistanceMap, JDialogEdgeDetection3D, JDialogEdgeLaplacian, JDialogEdgeNMSuppression, JDialogEdgePreservingSmoothing, JDialogEfficientWatershed, JDialogEntropicEdgeDetection, JDialogEntropyMinimization, JDialogErode, JDialogExtractBrain, JDialogFaceAnonymize, JDialogFaceAnonymizerBET, JDialogFacetModel, JDialogFastMarching, JDialogFFT, JDialogFillObjects, JDialogFindEdges, JDialogFIREEdgeExtraction, JDialogFlip, JDialogFrequencyFilter, JDialogFuzzMinDeAndChatterji, JDialogFuzzyCMeans, JDialogFuzzyConnectednessSegmentation, JDialogFuzzyMinimization, JDialogGaborFilter, JDialogGaussianBlur, JDialogGenerateGrid, JDialogGenerateIsolines, JDialogGradientInverseWeightedSmoothing, JDialogGradientMagnitude, JDialogGraphBasedSegmentation, JDialogGuidedFilter, JDialogHaralickTexture, JDialogHarrisCornerDetector, JDialogHillClimbingWatershed, JDialogHistogramMatch, JDialogHistogramSummary, JDialogHomomorphicFilter, JDialogIAGCWD, JDialogIDObjects, JDialogIHN3Correction, JDialogImRegPOC, JDialogInsertMissingSlices, JDialogInvert, JDialogIsophoteCurvature, JDialogKernelRegression, JDialogLaplacian, JDialogLawsTexture, JDialogLocalVariance, JDialogLowerCompletion, JDialogLuminanceAdaptation, JDialogMarkovSegment, JDialogMarkovSmooth, JDialogMaximumIntensityProjection, JDialogMean, JDialogMedian, JDialogMidsagittal, JDialogMode, JDialogMorphologicalFilter, JDialogMorphologicalGradient, JDialogMorphologicalLaplacian, JDialogMorphologicalReconstruction, JDialogMosaicToSlices, JDialogMultiResolutionBilateralFilter, JDialogMultiResolutionGuidedFilter, JDialogN4MRIBiasFieldCorrection, JDialogNLMeans_filt2D, JDialogNLNoiseReduction, JDialogNMSuppression, JDialogNoise, JDialogNoiseLevel, JDialogNonlocalMeansFilter, JDialogOpen, JDialogPadImages, JDialogParticleAnalysisNew, JDialogPbBoundaryDetection, JDialogPhasePreservingDenoising, JDialogPowerWatershed, JDialogPrincipalComponents, JDialogRegistrationBSpline, JDialogRegistrationOAR2D, JDialogRegistrationOAR3D, JDialogRegPatientPos, JDialogRegularizedIsotropicDiffusion, JDialogReorient, JDialogReplaceBlankSlicesWithAverages, JDialogReplaceValue, JDialogReslice, JDialogRotate, JDialogRuleBasedContrastEnhancement, JDialogSCDSegmentation, JDialogScriptableTransform, JDialogSequentialScanningWatershed, JDialogShortestPathWatershed, JDialogSimulatedExposureFusion, JDialogSkeletonize, JDialogSM2, JDialogSobel, JDialogSplitAndMergeWatershed, JDialogSubsample, JDialogSubset, JDialogSwap34, JDialogSwapDims, JDialogSwapSlicesVolumes, JDialogSWI, JDialogSymmetricNearestNeighbor, JDialogTamuraTexture, JDialogTextureSegmentation, JDialogThinning2D, JDialogTiltCorrection, JDialogTopHat, JDialogTransformBSpline, JDialogTreT1, JDialogTrilateralFilter, JDialogUnionFindComponentLabelling, JDialogUnionFindWatershed, JDialogUnsharpMask, JDialogVesselEnhancement, JDialogVOIHausdorffDistance, JDialogVOILogicalOperations, JDialogWaveletFuse, JDialogWaveletThreshold, MTryJistHook

public interface ActionDiscovery

Classes which implement this interface are able to report metainformation about themselves, return their input and output parameters, run their action using a set of input parameters, retrieve the real name of images they output, and return whether they have completed successfully. The input parameters returned by createInputParameters() should match up with the parameters used by the action's implementation of the MIPAV scripting system. The scriptRun(ParameterTable) method should be shared with the action's implementation of the MIPAV scripting system.

Method Summary

Modifier and Type	Method	Description
ParameterTable	createInputParameters()	Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in #setGUIFromParams()).
ParameterTable	createOutputParameters()	Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).
ActionMetadata	getActionMetadata()	Return meta-information about this discoverable action for categorization and labeling purposes.
java.lang.String	getOutputImageName(java.lang.String imageParamName)	Returns the name of an image output by this algorithm, the image returned depends on the parameter label given (which can be used to retrieve the image object from the image registry).
boolean	isActionComplete()	Returns whether the action has successfully completed its execution.
void	scriptRun(ParameterTable table)	Starts execution of the action.

Method Detail

getActionMetadata

ActionMetadata getActionMetadata()

Return meta-information about this discoverable action for categorization and labeling purposes.

Returns:

Metadata for this action.

createInputParameters

ParameterTable createInputParameters()

Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in #setGUIFromParams()).

Returns:

A parameter table listing the inputs of this algorithm.

createOutputParameters

ParameterTable createOutputParameters()

Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).

Returns:

A parameter table listing the outputs of this algorithm.

scriptRun

void scriptRun(ParameterTable table)

Starts execution of the action. Should be the same as the scriptRun() method used by the MIPAV scripting system.

Parameters:

table - The input parameters (with values set) to be used to run the action.

getOutputImageName

java.lang.String getOutputImageName(java.lang.String imageParamName)

Returns the name of an image output by this algorithm, the image returned depends on the parameter label given (which can be used to retrieve the image object from the image registry).

Parameters:

imageParamName - The output image parameter label for which to get the image name.

Returns:

The image name of the requested output image parameter label.

isActionComplete

boolean isActionComplete()

Returns whether the action has successfully completed its execution.

Returns:

True, if the action is complete. False, if the action failed or is still running.