Abstract type for sources of citable image

Rectangular regions of interest

Basic abstraction for region-of-interest

Define singleton type for use with CitableTrait

Define singleton type to use as value for CitableCollectionTrait.

An instance of an IIIF image service.

Define singleton type to use as value of CexTrait on MSPage.

Define singleton type to use as value of CitableTrait on ImageRecord.

A collection of ImageRecords.

Define singleton type to use as value for CitableCollectionTrait.

Define singleton type to use as value for UrnComparisonTrait.

Define singleton type to use as value of UrnComparisonTrait on MSPage.

Metadata for a citable digital image

Structure to hold images in a 2-D array of rowsXcolumns.

An instance of an IIIF image service.

• basedirectory is the root directory of image files organized either in a single flat directory, or in a subdirectory tree mirroring image URN components.
• expandpath True if paths to images should be expanded to mirror components of an image URN.

A rectangular region of interest defined by top y, left x, height and width of rectangle.

A rectangular region of interest defined by top y, left x, height and width of rectangle in percentages. x and y are the dimensions in pixels of the image.

Override Base.== for ImageCollection.

==(c1, c2)

Override == for ImageRecord

==(img1, img2)

An ImageCollection is a collection of ImageRecords.

eltype(imgcoll)

Filter the list of images in an ImageCollection.

filter(f, imgcoll)

Iterate an ImageCollection with array index at state.

iterate(imgcoll, state)

Initial state of iterator for an ImageCollection.

iterate(imgcoll)

Iterate pages of a Lightbox from page given in state.

iterate(lb, state)

Begin iterating pages of a Lightbox with page 1.

iterate(lb)

Number of images in collection.

length(imgcoll)

Reverse the order of images in an ImageCollection.

reverse(imgcoll)

Override Base.show for ImageCollection.

show(io, imgcoll)

Override show for ImageRecord

show(io, img)

Required for CitableTrait.

Serialize imgcoll to delimited text in CEX format.

cex(imgcoll; delimiter)

Serialize image record img to delimited text.

cex(img; delimiter)

Required for CexTrait.

Define value of CexTrait for ImageCollection.

cextrait(_)

Set value of CexTrait for MSPage.

cextrait(_)

Define value of CitableCollectionTrait for ImageCollection.

citablecollectiontrait(_)

Define value of CitableTrait for ImageCollection

citabletrait(_)

Set value of CitableTrait for ImageRecord.

citabletrait(_)

Instantiate aν ImageRecordfrom delimited text.

fromcex(
    traitvalue,
    cexsrc,
    T;
    delimiter,
    configuration,
    strict
)

Instantiate an ImageCollection from cexsrc.

fromcex(trait, cexsrc, T; delimiter, configuration, strict)

If strict is true, then the function uses data model declarations to find relevant data blocks. If strict is false, then it treats citedata blocks as source for a single ImageCollection.

Find collection-level URN for collection.

label(imgcoll)

Label for img.

label(img)

Required function for Citable abstraction.

Find collection-level URN for collection.

urn(imgcoll)

URN identifying img.

urn(img)

Required function for Citable abstraction.

Define value of UrnComparisonTrait for ImageCollection.

urncomparisontrait(_)

Set value of UrnComparisonTrait for ImageRecord.

urncomparisontrait(_)

Implement URN comparison for containment on imgcoll.

urncontains(u, imgcoll)

Implement urn comparison for containment for ImageRecord.

urncontains(u, img)

Implement URN comparison for equality on imgcoll.

urnequals(u, imgcoll)

Implement urn comparison for equality for ImageRecord.

urnequals(u, img)

Implement URN comparison for similarity on imgcoll.

urnsimilar(u, imgcoll)

Implement urn comparison for similarity for ImageRecord.

urnsimilar(u, img)

Image collections are citable by Cite2Urn.

urntype(imgcoll)

Type of URN identifying an ImageRecord.

urntype(_)

Required function for Citable abstraction.

Base directory for images in a local file system.

basedirectory(imgsrc)

Maximim Y value of region of interest.

bottom(r)

Catch subtypes of AbstractRectRoi that fail to implement bottom

Number of columns per page in lb.

columns(lb)

Number of columns in imgtable.

columns(imgtable)

Compose datamodels CEX block for imgcoll.

datamodelcex(imgcoll; delimiter)

Height in pixels of region of interest.

h(r)

Catch subtypes of AbstractRectRoi that fail to implement h

Compose HTML img element for image retrieved from an IIIF service.

htmlImage(img, service; w, caption)

Convenience function for creating ImageCollections.

image_collection(images; description)

Extract region-of-interest string from an image URN, and convert to a vector of floats rounded to digits significant places. It is an error if the syntax of the URN's subreference is invalid.

imagefloats(imgu; digits)

Compose full path to the image file imgurn.

imgpath(imgsrc, imgurn; extension)

Minimum X value in pixels for region of interest.

left(r)

Catch subtypes of AbstractRectRoi that fail to implement left

Construct a Lightbox from an ImageCollection.

lightbox(imgcoll; cols, rows)

Compose markdown wrapping IIIF URL for image linked to an image citation tool installation.

linkedHtmlImage(ict, img, service; w, caption)

Compose markdown wrapping IIIF URL for image linked to an image citation tool installation.

linkedMarkdownImage(
    ict,
    img,
    service;
    w,
    caption,
    extension
)

Arguments

• ict URL of an instance of the CiteArchitecture ImageCitationTool.
• img Cite2Urn for an image.
• service IIIFService
• w Width of resulting image in pixels.
• caption Caption to embed in resulting linked markdown string.

Instantiate an Image from a URN. Returns a matrix of RGB values.

load_rgb(imgurn)

Instantiate an Image from a URN. Returns a matrix of RGBA values.

load_rgba(imgurn; alpha)

Convenience function to create a LocalImageFiles that will expand paths from URNs by default.

localimages(basedir; expandpath)

Compose markdown wrapping an IIIF URL for retrieving an image.

markdownImage(img, service; w, caption)

Arguments

• img Cite2Urn for an image.
• service IIIFService
• ht Height of resulting image in pixels.

Compose markdown table header.

mdheaderlines(imgtable)

Compose a markdown table for page page of lb thumbnail image size in pixels == thumbsize.

mdtable(lb)
mdtable(lb, page; iiif, ict, thumbsize)

Compose a markdown table for imgtable with thumbnail image size in pixels == thumbsize.

mdtable(imgtable; iiif, ict, thumbsize)

Compose a markdown table for all pages in lb.

mdtables(lb; iiif, ict, thumbsize)

Retrieve page n from lb.

page(lb; n)

Number of paged RxC tables in lb.

pages(lb)

Given a region-of-interest string, compose percent expression for IIIF.

pctString(s)

Argument

• s string with four comma-separated ROI values

Given a CITE2 URN with region-of-interest subreference, compose percent expression for IIIF.

pctString(u)

Compose citeproperties CEX blocks for imgcoll.

propertiescex(imgcoll; delimiter)

Retrieve RGB data for an image identified by URN from a IIIF service.

rgb_data(src, img; extension, w)

Retrieve binary image data cited by img from src.

rgb_data(src, img; extension, ht)

Catch subtypes that fail to implement rgb_data function.

Retrieve RGBA data for an image identified by URN from a IIIF service. Optionally set alpha channel on the resulting image.

rgba_data(src, img; extension, w, alpha)

Maximim X value of region of interest.

right(r)

Catch subtypes of AbstractRectRoi that fail to implement right

Given a region-of-interest string, compute percent values, with result rounded to a given number of digits.

roiFloats(s)
roiFloats(s, digits)

Arguments

• s string with four comma-separated ROI values
• digits precision of resulting float

Number of rows per page in lb.

rows(lb)

Number of rows in imgtable.

rows(imgtable)

Create directory path for a given urn.

subdirectory(urn)

Minimum Y value in pixels for region of interest.

top(r)

Catch subtypes of AbstractRectRoi that fail to implement top

Compose URL for retrieving an image from an IIIF service.

url(img, service; w, extension)

Arguments

• url Cite2Urn for an image.
• service IIIFService
• ht Height of resulting image in pixels.
• extension Extension for file name on server.

Scale an image to a fixed height.

urnscale(img)
urnscale(img, ht)

Extract a slice from img defined by a list of four values giving left top, width and height of a rectangle to extract.

urnslice(img, rect)

Width in pixels of region of interest.

w(r)

Catch subtypes of AbstractRectRoi that fail to implement w