Import a New Page (IM)

Description

This command is used to build the image master database for a project or to append additional image master records to an existing project. An image master record is the basis for displaying the images in Ipro View and for other image management functions. The image master records for the project’s images must be loaded into a project before any other LFP commands are loaded. The image master records facilitate the display and management of all of the annotations, highlights, and other information associated with a project’s images.

Generally the scanning vendor supplies an image master record for each image they produce and delivers the image master along with the images.

Command Structure

IM,[Image Key],[Boundary Flag],[Offset],[Unique Filename];[Type],[Rotate]

Examples

Example 1

IM,ALG-1-000001,S,87576658,0000001K.IMG,2

IM,ALG-1-000001,S,87576658,0000001K.STF,1

This example shows two Ipro image master records for the same image. The first image is upside down and the second image is rotated 90 degrees to the right.

Example 2

IM,0001,F,1,@FLD02;IMAGES\00\00;0000.PDF;5

IM,0002, ,2,@FLD02;IMAGES\00\00;0000.PDF;6,1

This example loads two images in a PDF file. The numbers 5 and 6 indicate that the PDFs are black/white and color, respectively. The color PDF is rotated 90 degrees.

Example 3

IM,ALG-004,,0,001001.TIF;2,1

This example shows a standard single-image TIFF. Because the image key is the same as the filename and there are no duplicate filenames, only the filename is required. The example shows a record with no boundary identifier. The default boundary is always Page, so it is not necessary to identify that boundary in the LFP file. The image is rotated 90 degrees.

Example 4

IM,IPR-1-000004,,0,@Ipro;001\Ipro;001005.PCX;4,3

This example shows a color image in a project that has duplicate filenames. The image key and filename are different, but because the filename may occur in multiple directories, the complete path to the images in this project must be stated. No boundary flag is set, and the default boundary is Page. The filename section begins with the at sign (@) and the volume followed by the path to the images (001\Ipro). The image is rotated 90 degrees to the left (270 degrees to the right).

Example 5

IM,ABC-00010,,2,@Vol01;Vol001/001;ABC-00010.tif;2

IM,ABC-00011,,3,@Vol01;Vol001/001;ABC-00010.tif;2

This example shows pages 2 and 3 of a multi-page Tiff file. Notice that the file name (ABC-00010.tif) is the same for both images (ABC-00010 and ABC-00011). The offset indicates the page number and is immediately before the at sign (@) in the LFP command.

Example 6

IM,MSC-00025,D,0,@;;;99

IM,MSC-00036, 0,@;;;99

This example shows image format type 99; a placeholder image.

Command Elements

Function or target

Description

[IM]

The identifier that indicates that a new page is to be added.

Image Key

The unique image key for the image. Maximum length is 70 characters.

[Boundary Flag]

A single letter that identifies a particular record as a boundary. Ipro View allows up to eight boundary levels, and you may use any letter to identify the project boundaries as long as it matches the boundary level defined in the project setup. To simplify your internal procedures, we also recommend consistency between projects. Whether you set boundaries at scan time depends on your project needs and the capabilities of your scanning vendor. Following are some common boundary flags and the identifiers:

S = Source

B = Box

F = Folder

D = Document

[Offset]

The location of the Ipro Tech image in the file. If your images are standard single image files, the offset for each record will be 0 (zero). For example, the fourth image in the file has an offset of 3.

[Unique Filename]

The complete filename and path to the image. If the file is an Ipro image (.IMG) or a standard single image without duplicate filenames, only the filename is required. However, if it is a different type of image file and the filename is duplicated in the project under different directories, this field must include the complete path to each image key.

The first part of the filename portion is the volume name. All volume names are preceded by the at sign (@). If the volume name is supplied, the drive letter is not necessary. The volume name can be up to 30 characters.

The path to the image is next. If a volume name exists, the drive letter is not entered with the path. If there is no volume name, the drive letter and the complete path must be included in the format provided in the examples above.

The filename of the image follows the path.

[Type]

A code for the image format.

1 Ipro image (.IMG)

2 Standard single- and multiple-page black and white or color TIFF (.TIF)

3 Ipro stacked TIFF (.STF)

4 Color image (.BMP, .PCX, .JPEG, or .PNG)

5 Black and white PDF

6 Color PDF

7 Auto-detect PDF

99 Placeholder

[Rotate]

The degree that a page is rotated. This setting is not present until the image has been rotated. Values include: 0=0, 1=90, 2=180, 3=270

Length Limitations

Length Limitations

Image Key

70 characters

Volume Name in IM or VN command

30 characters

Filename in IM command

80 characters

Path to Volume in VN command plus path to file in IM command

197 characters

Path to Volume (in VN command) plus path to file plus filename in IM command

217 characters

 

Related Topics

Ipro Tech LFP Files