Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

filename

Integer

SectionImage.id identifying the image to download.

expression

Boolean (optional)

Set the value to true to retrieve the specified SectionImage's expression mask image.

downsample

Integer (optional)

The number of times to downsample the original image. For example, 'downsample=1' halves the number of pixels of the original image both horizontally and vertically. Specifying 'downsample=2' quarters the height and width values.

quality

Integer (optional)

The jpeg quality of the returned image. This must be an integer from 0, for the lowest quality, up to as high as 100. If it is not specified, it defaults to the highest quality.

left

Integer (optional)

Index of the leftmost column of the region of interest, specified in full-resolution (largest tier) pixel coordinates. SectionImage.x is the default value.

top

Integer (optional)

Index of the topmost row of the region of interest, specified in full-resolution (largest tier) pixel coordinates. SectionImage.y is the default value.

width

Integer (optional)

Number of columns in the output image, specified in tier-resolution (desired tier) pixel coordinates. SectionImage.width is the default value. It is automatically adjusted when downsampled.

height

Integer (optional)

Number of rows in the output image, specified in tier-resolution (desired tier) pixel coordinates. SectionImage.height is the default value. It is automatically adjusted when downsampled.

range

Array (optional)

Filter to specify the RGB channels. The range parameter consists of 6 comma delimited integers that define the lower (0) and upper (255) bound for each channel in red-green-blue order (i.e. "range=0,1500,0,1000,0,4095"). The default range values can be determined by referring to the following fields on the Equalization model associated with the SectionDataSet: red_lower, red_uppper, green_lower, green_upper, blue_lower, blue_upper. For more information, see the "Image Controls" section of the Allen Mouse Brain Connectivity Atlas: Projection Dataset help topic.

...

Returns

...

A jpeg file of the requested image.

AtlasImage Download Service

The AtlasImage download service serves whole and partial two-dimensional images with annotations presented on the Allen Brain Atlas Web site.

...

Prototype

...

Code Block

http://api.brain-map.org/api/v2/atlas_image_download/[AtlasImage.id]?downsample=[#]&quality=[#]&annotation=[true|false]

...

Example

...

Download the downsampled AtlasImage 100883869 with annotations:

Code Block

http://api.brain-map.org/api/v2/atlas_image_download/100883869?downsample=4&annotation=true

...

Parameters

...

filename

Integer

AtlasImage.id identifying the image to download.

annotation

Boolean (optional)

Set the value to true to retrieve the specified AtlasImage with annotations.

downsample

Integer (optional)

The number of times to downsample the original image. For example, 'downsample=1' halves the number of pixels of the original image both horizontally and vertically. Specifying 'downsample=2' quarters the height and width values.

quality

Integer (optional)

The jpeg quality of the returned image. This must be an integer from 0, for the lowest quality, up to as high as 100. If it is not specified, it defaults to the highest quality.

left

Integer (optional)

Index of the leftmost column of the region of interest, specified in full-resolution (largest tier) pixel coordinates. SectionImage.x is the default value.

top

Integer (optional)

Index of the topmost row of the region of interest, specified in full-resolution (largest tier) pixel coordinates. SectionImage.y is the default value.

width

Integer (optional)

Number of columns in the output image, specified in tier-resolution (desired tier) pixel coordinates. SectionImage.width is the default value. It is automatically adjusted when downsampled.

height

Integer (optional)

Number of rows in the output image, specified in tier-resolution (desired tier) pixel coordinates. SectionImage.height is the default value. It is automatically adjusted when downsampled.

...

Returns

...

A jpeg file of the requested image.

ProjectionImage Download Service

The Projection Image download service serves whole and partial two-dimensional images with projection data presented on the Allen Brain Atlas Web site.

...

Prototype

...

Code Block

http://api.brain-map.org/api/v2/projection_image_download/[SectionImage.id]?downsample=[#]&quality=[#]&projection=[true|false]

...

Example

...

Download the downsampled SectionImage 126862583 with projection:

Code Block

http://api.brain-map.org/api/v2/projection_image_download/126862583?downsample=4&projection=true

...

Parameters

...

filename

Integer

SectionImage.id identifying the image to download.

projection

Boolean (optional)

Set the value to true to retrieve the specified SectionImage with projection.

downsample

Integer (optional)

The number of times to downsample the original image. For example, 'downsample=1' halves the number of pixels of the original image both horizontally and vertically. Specifying 'downsample=2' quarters the height and width values.

quality

Integer (optional)

The jpeg quality of the returned image. This must be an integer from 0, for the lowest quality, up to as high as 100. If it is not specified, it defaults to the highest quality.

left

Integer (optional)

Index of the leftmost column of the region of interest, specified in full-resolution (largest tier) pixel coordinates. SectionImage.x is the default value.

top

Integer (optional)

Index of the topmost row of the region of interest, specified in full-resolution (largest tier) pixel coordinates. SectionImage.y is the default value.

width

Integer (optional)

Number of columns in the output image, specified in tier-resolution (desired tier) pixel coordinates. SectionImage.width is the default value. It is automatically adjusted when downsampled.

height

Integer (optional)

Number of rows in the output image, specified in tier-resolution (desired tier) pixel coordinates. SectionImage.height is the default value. It is automatically adjusted when downsampled.

...

Returns

...

A jpeg file of the requested image.