io.cortical.services

Interface Images

public interface Images

The Image Retina API.

Method Summary

Methods

Modifier and Type	Method and Description
ByteArrayInputStream	compare(ImagePlotShape shape, ImageEncoding imageEncoding, Model model1, Model model2) Returns a visualization of the comparison of two fingerprints.
ByteArrayInputStream	compare(ImagePlotShape shape, ImageEncoding imageEncoding, String jsonModel) Returns a visualization of the comparison of two fingerprints.
ByteArrayInputStream	compare(Integer scalar, ImagePlotShape shape, ImageEncoding imageEncoding, Model model1, Model model2) Returns a visualization of the comparison of two fingerprints.
ByteArrayInputStream	compare(Integer scalar, ImagePlotShape shape, ImageEncoding imageEncoding, String jsonModel) Returns a visualization of the comparison of two fingerprints.
ByteArrayInputStream	compare(Model model1, Model model2) Returns a visualization of the comparison of two fingerprints.
ByteArrayInputStream	compare(String jsonModel) Returns a visualization of the comparison of two fingerprints.
ByteArrayInputStream	getImage(ImagePlotShape shape, Double sparsity, Model model) Generate an image for the for the model.
ByteArrayInputStream	getImage(ImagePlotShape shape, Double sparsity, String jsonModel) Generate an image for the for the model.
ByteArrayInputStream	getImage(Integer scalar, ImagePlotShape shape, ImageEncoding imageEncoding, Double sparsity, Model model) Generate an image for the for the model.
ByteArrayInputStream	getImage(Integer scalar, ImagePlotShape shape, ImageEncoding imageEncoding, Double sparsity, String jsonModel) Generate an image for the for the model.
ByteArrayInputStream	getImage(Model model) Generate an image for the for the model.
ByteArrayInputStream	getImage(String jsonModel) Generate an image for the for the model.
List<Image>	getImageBulk(Boolean includeFingerprint, Integer scalar, ImagePlotShape shape, Double sparsity, Model... models) Returns a List of Images for the input models.
List<Image>	getImageBulk(Boolean includeFingerprint, Integer scalar, ImagePlotShape shape, Double sparsity, String jsonModel) Returns a List of Images for the input models.
List<Image>	getImageBulk(ImagePlotShape shape, Double sparsity, Model... models) Returns a List of Images for the input models.
List<Image>	getImageBulk(ImagePlotShape shape, Double sparsity, String jsonModel) Returns a List of Images for the input models.
List<Image>	getImageBulk(Model... models) Returns a List of Images for the input models.
List<Image>	getImageBulk(String jsonModel) Returns a List of Images for the input models.

Method Detail

getImageBulk

List<Image> getImageBulk(Boolean includeFingerprint,
                       Integer scalar,
                       ImagePlotShape shape,
                       Double sparsity,
                       Model... models)
                         throws com.fasterxml.jackson.core.JsonProcessingException,
                                ApiException

Returns a List of Images for the input models.

Parameters:

includeFingerprint - : true if the fingerprint should be provided in the response.

scalar - : scaling factor of the image to generate

shape - : shape of the plots used in the overlay image

sparsity - : a sparsity value which can be applied to the image

models - : models for which the images are generated.

Returns:

a list of images generated using the input models.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImageBulk

List<Image> getImageBulk(ImagePlotShape shape,
                       Double sparsity,
                       Model... models)
                         throws com.fasterxml.jackson.core.JsonProcessingException,
                                ApiException

Returns a List of Images for the input models.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR

Parameters:

shape - : shape of the plots used in the overlay image

models - : models for which the images are generated.

sparsity - : a sparsity value which can be applied to the image

Returns:

a list of images generated using the input models.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImageBulk

List<Image> getImageBulk(Model... models)
                         throws com.fasterxml.jackson.core.JsonProcessingException,
                                ApiException

Returns a List of Images for the input models.
The default image shape is DefaultValues.DEF_VALUE_PLOT_SHAPE
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

models - : models for which the images are generated.

Returns:

a list of images generated using the input models.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImage

ByteArrayInputStream getImage(Integer scalar,
                            ImagePlotShape shape,
                            ImageEncoding imageEncoding,
                            Double sparsity,
                            Model model)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Generate an image for the for the model.

Parameters:

scalar - : scaling factor of the image to generate

shape - : shape of the plots used in the overlay image

imageEncoding - : the encoding of the image.

sparsity - : a sparsity value which can be applied to the image

model - : a model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImage

ByteArrayInputStream getImage(ImagePlotShape shape,
                            Double sparsity,
                            Model model)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Generate an image for the for the model.
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR
The default image encoding is DefaultValues.DEF_VALUE_IMAGE_ENCODING

Parameters:

shape - : shape of the plots used in the overlay image

sparsity - : a sparsity value which can be applied to the image

model - : a model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImage

ByteArrayInputStream getImage(Model model)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Generate an image for the for the model.
The default image shape is DefaultValues.DEF_VALUE_PLOT_SHAPE
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY
The default image encoding is DefaultValues.DEF_VALUE_IMAGE_ENCODING

Parameters:

model - : a model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

compare

ByteArrayInputStream compare(Integer scalar,
                           ImagePlotShape shape,
                           ImageEncoding imageEncoding,
                           Model model1,
                           Model model2)
                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                    ApiException

Returns a visualization of the comparison of two fingerprints.

The returned image contains a visualization of the left and right fingerprint and the overlay of both fingerprints.

Parameters:

scalar - : scaling factor of the image to generate

shape - : shape of the plots used in the overlay image

imageEncoding - : the encoding of the image.

model1 - : a model for which the fingerprint's image is generated.

model2 - : a model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

compare

ByteArrayInputStream compare(ImagePlotShape shape,
                           ImageEncoding imageEncoding,
                           Model model1,
                           Model model2)
                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                    ApiException

Returns a visualization of the comparison of two fingerprints.

The returned image contains a visualization of the left and right fingerprint and the overlay of both fingerprints.

The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR

Parameters:

shape - : shape of the plots used in the overlay image

imageEncoding - : the encoding of the image.

model1 - : a model for which the fingerprint's image is generated.

model2 - : a model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

compare

ByteArrayInputStream compare(Model model1,
                           Model model2)
                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                    ApiException

Returns a visualization of the comparison of two fingerprints.

The returned image contains a visualization of the left and right fingerprint and the overlay of both fingerprints.

The default image shape is DefaultValues.DEF_VALUE_PLOT_SHAPE
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR
The default image encoding is DefaultValues.DEF_VALUE_IMAGE_ENCODING\

Parameters:

model1 - : a model for which the fingerprint's image is generated.

model2 - : a model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImageBulk

List<Image> getImageBulk(Boolean includeFingerprint,
                       Integer scalar,
                       ImagePlotShape shape,
                       Double sparsity,
                       String jsonModel)
                         throws com.fasterxml.jackson.core.JsonProcessingException,
                                ApiException

Returns a List of Images for the input models.

Parameters:

includeFingerprint - : identify if the fingerprint should be present/provided in the images.

scalar - : scaling factor of the image to generate

shape - : shape of the plots used in the overlay image

sparsity - : a sparsity value which can be applied to the image

jsonModel - : json model for which the images are generated.

Returns:

a list of images generated using the input models.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImageBulk

List<Image> getImageBulk(ImagePlotShape shape,
                       Double sparsity,
                       String jsonModel)
                         throws com.fasterxml.jackson.core.JsonProcessingException,
                                ApiException

Returns a List of Images for the input models.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR

Parameters:

shape - : shape of the plots used in the overlay image

jsonModel - : json model for which the images are generated.

sparsity - : a sparsity value which can be applied to the image

Returns:

a list of images generated using the input models.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImageBulk

List<Image> getImageBulk(String jsonModel)
                         throws com.fasterxml.jackson.core.JsonProcessingException,
                                ApiException

Returns a List of Images for the input models.
The default image shape is DefaultValues.DEF_VALUE_PLOT_SHAPE
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

jsonModel - : json model for which the images are generated.

Returns:

a list of images generated using the input models.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImage

ByteArrayInputStream getImage(Integer scalar,
                            ImagePlotShape shape,
                            ImageEncoding imageEncoding,
                            Double sparsity,
                            String jsonModel)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Generate an image for the for the model.

Parameters:

scalar - : scaling factor of the image to generate

shape - : shape of the plots used in the overlay image

imageEncoding - : the encoding of the image.

sparsity - : a sparsity value which can be applied to the image

jsonModel - : json model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImage

ByteArrayInputStream getImage(ImagePlotShape shape,
                            Double sparsity,
                            String jsonModel)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Generate an image for the for the model.
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR
The default image encoding is DefaultValues.DEF_VALUE_IMAGE_ENCODING

Parameters:

shape - : the shape of the plots used in the overlay image

sparsity - : the sparsity that should be applied to the image

jsonModel - : a json model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

getImage

ByteArrayInputStream getImage(String jsonModel)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Generate an image for the for the model.
The default image shape is DefaultValues.DEF_VALUE_PLOT_SHAPE
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY
The default image encoding is DefaultValues.DEF_VALUE_IMAGE_ENCODING

Parameters:

jsonModel - : a json model for which the fingerprint's image is generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

compare

ByteArrayInputStream compare(Integer scalar,
                           ImagePlotShape shape,
                           ImageEncoding imageEncoding,
                           String jsonModel)
                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                    ApiException

Returns a visualization of the comparison of two fingerprints.

The returned image contains a visualization of the left and right fingerprint and the overlay of both fingerprints.

Parameters:

scalar - : scaling factor of the image to generate

shape - : the shape of the plots used in the overlay image

imageEncoding - : the encoding of the image.

jsonModel - : a json model for which the fingerprint's images are generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

compare

ByteArrayInputStream compare(ImagePlotShape shape,
                           ImageEncoding imageEncoding,
                           String jsonModel)
                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                    ApiException

Returns a visualization of the comparison of two fingerprints.

The returned image contains a visualization of the left and right fingerprint and the overlay of both fingerprints.

The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR

Parameters:

shape - : the shape of the plots used in the overlay image

imageEncoding - : the encoding of the image.

jsonModel - : a json model for which the fingerprint's images are generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.

compare

ByteArrayInputStream compare(String jsonModel)
                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                    ApiException

Returns a visualization of the comparison of two fingerprints.

The returned image contains a visualization of the left and right fingerprint and the overlay of both fingerprints.

The default image shape is DefaultValues.DEF_VALUE_PLOT_SHAPE
The default image scalar is DefaultValues.DEF_VALUE_PLOT_SCALAR
The default image encoding is DefaultValues.DEF_VALUE_IMAGE_ENCODING\

Parameters:

jsonModel - : a json model for which the fingerprint's images are generated.

Returns:

a byte array holding the image data.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model(s).

ApiException - : if there are some server or connection issues.