Package qupath.opencv.ml

Class PatchClassifierParams

java.lang.Object
qupath.opencv.ml.PatchClassifierParams
public class PatchClassifierParams extends Object
Parameters required to build a classifier that operates on an image patch.

This is typically used to create a PixelClassifier. It can also be used to create an ObjectClassifier that takes image patches as input (rather that features extracted from object ROIs or measurement lists).

Since:
v0.4.0

  • Method Details

    • getInputChannels

      public List<ColorTransforms.ColorTransform> getInputChannels()
      Get the channels to extract from the image as input to the model.
      Returns:
      the input channels.

    • getPatchWidth

      public int getPatchWidth()
      Get the width of a patch, in pixels.
      Returns:
      the width of a patch in pixels

    • getPatchHeight

      public int getPatchHeight()
      Get the height of a patch, in pixels.
      Returns:
      the height of a patch in pixels

    • getHalo

      public Padding getHalo()
      Get the 'halo' around the output. This can be used to determine appropriate padding to avoid tile boundary artifacts. Can be null or empty.
      Returns:
      the padding

    • getInputResolution

      public PixelCalibration getInputResolution()
      Get the requested input resolution for the image.
      Returns:
      the requested pixel calibration of the input

    • getOutputChannelType

      public ImageServerMetadata.ChannelType getOutputChannelType()
      Get the requested output channel type.
      Returns:
      the requested output type

    • getOutputClasses

      public Map<Integer,PathClass> getOutputClasses()
      Get the classifications for the output. Keys to the map are generally channel numbers of the output (zero-based), or could be labels in a single-channel labeled image.
      Returns:
      a map from ints to class names.

    • getPreprocessing

      public List<ImageOp> getPreprocessing()
      Get any preprocessing steps that should be applied.
      Returns:
      the preprocessing operations.

    • getPredictionOp

      public ImageOp getPredictionOp()
      Get the image op used for prediction only. This is applied after any preprocessing steps, but before any postprocessing steps.
      Returns:
      the prediction operation.

    • getPostprocessing

      public List<ImageOp> getPostprocessing()
      Get any postprocessing steps that should be applied after prediction.
      Returns:
      the postprocessing operations.

    • buildPixelClassifier

      public static PixelClassifier buildPixelClassifier(PatchClassifierParams params)
      Build a pixel classifier using these parameters
      Parameters:
      params - the classifier parameters.
      Returns:
      a pixel classifier using the input parameters.

    • builder

      public static PatchClassifierParams.Builder builder()
      Create a builder to generate new patch classifier params.
      Returns:
      a new builder.

    • builder

      public static PatchClassifierParams.Builder builder(PatchClassifierParams params)
      Create a builder to generate new patch classifier params, initialized with the values from an existing parameter object.
      Parameters:
      params - the existing parameters, used to initialize the builder
      Returns:
      a builder using the input parameters.