Package com.esri.arcgisruntime.raster

Class FrameCameraAddRastersParameters

  • public final class FrameCameraAddRastersParameters
extends AddRastersParameters
    Adds raster datasets to a MosaicDatasetRaster by setting various parameters including the use of frame and camera text files.

    Mosaic datasets (via the MosaicDatasetRaster class) are used to manage, display, serve, and share raster data. When you create a new mosaic dataset, it is created as an empty container in a geodatabase to which you can add raster data. The FrameCameraAddRastersParameters object provides the mechanism to set various properties including the use of camera and frame text files so that a raster can be added to a mosaic dataset via the MosaicDatasetRaster.addRastersAsync(AddRastersParameters) method.

    Some of the parameters (properties) on FrameCameraAddRastersParameters class that enable adding a raster into a mosaic dataset include specifying the file filter type (like .tif or .jpg) of the rasters that are to be included (AddRastersParameters.setFilter(String)), the directory location (AddRastersParameters.setInputDirectory(String)) of the raster files, the minimum pixel cell size of the raster to be included (AddRastersParameters.setMinPixelSizeFactor(double)) and more.

    Unique attributes of using the FrameCameraAddRastersParameters class rather than the parent AddRastersParameters class have to do with defining 'frame' and 'camera' text files which specify how a raster image was captured from a satellite or aircraft. The frame and camera table files refers to a single perspective imaging camera with an optical lens that can be modeled as a pinhole. To define the frame table use setFramesFile(String), see the ArcGIS Pro document entitled 'Frames table schema' (https://pro.arcgis.com/en/pro-app/help/data/imagery/frames-table-schema.htm) for more information. To define the camera table use setCamerasFile(String), see the ArcGIS Pro document entitled 'Cameras table schema' (https://pro.arcgis.com/en/pro-app/help/data/imagery/cameras-table-schema.htm) for more information.

    Since:
    100.2.0

    • Constructor Detail

      • FrameCameraAddRastersParameters

        public FrameCameraAddRastersParameters()
        Creates a FrameCameraAddRastersParameters instance.
        Since:
        100.2.0

    • Method Detail

      • getCamerasFile

        public String getCamerasFile()
        Gets the cameras file.
        Returns:
        the cameras file
        Since:
        100.2.0

      • setCamerasFile

        public void setCamerasFile​(String camerasFile)
        Sets the cameras file.
        Parameters:
        camerasFile - the cameras file
        Since:
        100.2.0

      • getFramesFile

        public String getFramesFile()
        Gets the frames file.
        Returns:
        the frames file
        Since:
        100.2.0

      • setFramesFile

        public void setFramesFile​(String framesFile)
        Sets the frames file.
        Parameters:
        framesFile - the frames file
        Since:
        100.2.0

      • isShareRasterInfo

        public boolean isShareRasterInfo()
        Gets a boolean that indicates whether to share the raster info.
        Returns:
        true if the raster info is going to be shared, otherwise false
        Since:
        100.2.0

      • setShareRasterInfo

        public void setShareRasterInfo​(boolean shareRasterInfo)
        Sets a boolean that indicates whether to share the raster info.
        Parameters:
        shareRasterInfo - true if the raster info is going to be shared, otherwise false
        Since:
        100.2.0