Filters - dsimaging/dsio-filters-api GitHub Wiki

This page is concerned with post-processing filters and image resources. All of the filter Api methods return a binary response representing the filtered image media that is encoded in a format described by the Content-Type header. The default format is PNG (image/png), however, the response can be controlled by the caller by specifying a desired media format in the Accept header. The following are accepted values for the Accept header:

Accept Response schema
image/png PNG format
image/tiff TIFF format
image/jpeg JPEG format
image/gif GIF format

Note that only PNG and TIFF formats support 16-bit gray scale images. All other types are compressed and may contain some data loss.

Unmap Image 

POST/images/{id}/filters/unmap

This method returns the original image.

Authorization

BasicAuth

Path Parameter

Parameter Type Required? Description
id string Yes Id of the image resource to process

Responses

200 Success

404 Image resource not found

410 Image media for this resource could not be found

Response schema: image/*

The body of a successful response will contain binary data in the format defined by the Content Type header (typically, image/png).

Apply Select Filter 

POST/images/{id}/filters/select

This method applies the Select Filter to the specified image resource and returns the filtered image. This filter is optimized for images acquired from Xios XG Select and Schick (CDR) Elite sensors.

Images acquired from Xios XG Select and Schick (CDR) Elite sensors will have the family property of SensorInfo populated with the value: Select.

See Use Cases for more information.

Authorization

BasicAuth

Path Parameter

Parameter Type Required? Description
id string Yes Id of the image resource to process

Responses

200 Success

400 Supplied SelectFilter contains invalid parameters

404 Image resource not found

410 Image media for this resource could not be found

Response schema: image/*

The body of a successful response will contain binary data in the format defined by the Content Type header (typically, image/png).

Request

The parameters used to process the image

Request body schema: application/json

Body

Name Type Description
enhancementMode string The Select enhancement mode. Enum:

Example

{
 "enhancementMode": "edgePro",
}

Apply Supreme Filter 

POST/images/{id}/filters/supreme

This method applies the Supreme Filter to the specified image resource and returns the filtered image. This filter is optimized for images acquired from Xios XG Supreme and Schick 33 sensors.

Images acquired from Xios XG Supreme and Schick 33 sensors will have the family property of SensorInfo populated with the value: Supreme.

See Use Cases for more information.

Authorization

BasicAuth

Path Parameter

Parameter Type Required? Description
id string Yes Id of the image resource to process

Responses

200 Success

400 Supplied SupremeFilter contains invalid parameters

404 Image resource not found

410 Image media for this resource could not be found

Response schema: image/*

The body of a successful response will contain binary data in the format defined by the Content Type header (typically, image/png).

Request

The parameters used to process the image

Request body schema: application/json

Body

Name Type Description
task string The task associated with the filter. Enum:
  • general - emphasis on general tooth and bone but without metal detection
  • endodontic - same as general but with metal detection
  • periodontic - similar to endodontic but with more emphasis on soft tissue areas
  • restorative - more emphasis on areas related to dental restorations
  • hygiene - similar to general but with a lighter overall tone
sharpness number (float) The sharpness to apply to the image expressed as a percentage in the range 0-100

Example

{
"task": "general",
"sharpness": 70,
}

Apply AE Filter 

POST/images/{id}/filters/ae

This method applies the AE Filter to the specified image resource and returns the filtered image. This filter is optimized for images acquired from Xios AE and Schick AE sensors.

Images acquired from Xios AE and Schick AE sensors will have the family property of SensorInfo populated with the value: Velocity.

See Use Cases for more information.

Authorization

BasicAuth

Path Parameter

Parameter Type Required? Description
id string Yes Id of the image resource to process

Responses

200 Success

400 Supplied AEFilter contains invalid parameters

404 Image resource not found

410 Image media for this resource could not be found

Response schema: image/*

The body of a successful response will contain binary data in the format defined by the Content Type header (typically, image/png).

Request

The parameters used to process the image

Request body schema: application/json

Body

Name Type Description
task string The task associated with the filter. Enum:
  • general - balanced for general tooth and bone display
  • endodontic - emphasis on root apices, pulp chamber, lamina dura, periodontal ligament, and cementum
  • periodontic - emphasis on alveolar and crestal bone and calculus
  • restorative - emphasis on enamel, dentin, DEJ, and CEJ
sharpness number (float) The sharpness to apply to the image expressed as a percentage in the range 0-100

Example

{
"task": "general",
"sharpness": 70,
}
⚠️ **GitHub.com Fallback** ⚠️