FileIn
Function
This allows you to read in image from either a disk or other external
device. It recognizes local, absolute, or even URL paths. To do a URL
address, you put a // in front of the path. For example, to read from
an Accom, you could do //accom1/# as your file path. If Shake tries
to evaluate an image that does not exist, it will give a black frame at
720x486 resolution.
If you want to refer to an image sequence, you can replace the frame
number with a # sign or a @ sign. The # sign signifies a 4-place padded
number, and the @ sign signifies an unpadded number. You may also use
several @ signs to indicated padding to a different number, for example,
001 would be @@@. Here are some examples:
Image |
Shake
Syntax |
image.iff |
image.iff |
image.1.iff, image.2.iff ... image.10.iff |
image.@.iff |
image1.iff, image2.iff, ... image10.iff |
image@.iff |
image.0001.cin, image.0002.cin,
... image.0010.cin |
image.#.cin |
image.001.cin, image.002.cin, ...
image.010.cin |
image.@@@.cin |
These assume that there is an exact relation between the
current frame processed in Shake, and the frame being read in, ie, at
frame 1, image.1 is being read in. If you are reading the images
in from the GUI with Sequence Listing, you will see the actual sequence
in the fileName field, for example,
Image |
Shake
Syntax with Sequence Listing |
image.4.iff, image.5.iff ... image.10.iff |
image.4-10@.iff |
image.4, image.5.iff, image.6.iff,
image.10.iff |
image.4-6,10@.iff |
Unlike the previous examples, this will offset the clip
timing by placing image.4.iff at frame 1 and image.5.iff
at frame 2. In the first example, image 10 goes to frame 7, and frame
4 in the second example. All sequence gaps are ignored.
However, all of this is academic, since the script uses
IRetime to
adjust clip start and end frames, offsets, and repeating behavior. This
function is attached invisibly in the Node View whenever
you adjust the clip in the Time View. To see its parameters,
open up timing in the FileIn parameters in the GUI.
For more information on file formats and I/O, jump to
About I/O.
For more information on time and clips, jump to About
Time.
Supported
File Formats
Parameters
|
Type
|
Defaults
|
Function
|
imageName |
string
|
|
The local or absolute path to the image.
See above for format. |
fileFormat |
string
|
"auto" |
This tells Shake what the format is if
the title is ambiguous. Generally, you do not need to set this, as
"Auto" will automatically detect the format. If you have
a problem reading an image, try setting the format to correct this.
|
autoAlpha |
int
|
0 |
If this is on (1), then Shake will create
a solid alpha channel for images not containing an alpha channel.
If the image already has an alpha channel, this parameter is ignored. |
deInterlacing |
int
|
0 |
This parameter is to be used when importing
interlaced images and you intend to render with fieldRendering on.
It will take the odd or even field of the image (counted from the
top) and copies it over the other remaining field. It then does the
same thing half a frame forward. You are therefore left with two images
the same height as your input image, but squeezed into the same time
frame. See About
Video for more information. |
Synopis*
image FileIn (
const char * imageName,
const char * fileFormat,
int autoAlpha,
int deInterlacing
);
Script*
image = FileIn(
"imageName",
"fileFormat",
autoAlpha,
deInterlacing
);
Command Line*
shake imageName imageName2 imageName3 etc....
*Note: Timing parameter are automatically added into the FileIn
by the IRetime function,
which will supply timing information for the FileIn function.
See Also
FileOut, Average
|