Functions
def	add_prman_render_task

def	add_maya_batch_render_task

def	add_txmake_task

def	add_denoise_task

def	get_denoise_filtered_name

def	generate_denoise_tasks

def	wait_for_txmanager

def	generate_txmake_tasks

def	add_job_level_attrs

def	generate_rib_render_tasks

def	generate_maya_batch_render_tasks

def	generate_job_file

def	batch_render_spool

def	batch_preview

def	register_tractor_prefs

Function Documentation

def rfm2.spool.rfm_tractor.add_denoise_task	(	parentTask,
		title,
		args,
		imgs,
		preview_imgs = `[]`,
		variance_files = `[]`
	)

Create a single denoise task for Tractor job.

Args:
- parentTask (Task) - parent task that this denoise task belongs to.
- title (str) - title to use for this task.
- args (list) - arguments to denoiser
- imgs (list) - list of images to be denoised
- preview_imgs (list) - list of images to generate preview tasks
- variance_files (list) - list of variance files

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.add_job_level_attrs	(	is_localqueue,
		job
	)

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.add_maya_batch_render_task	(	parentTask,
		title,
		stash_scene_name,
		img,
		is_anim,
		start,
		end,
		by,
		args = `[]`
	)

Create a single Maya Render task for a Tractor job.

Args:
- parentTask (Task) - parent task that this Maya Render task belongs to.
- title (str) - title to use for this task.
- stash_scene_name (str) - full path to the scene file name.
- img (str) - full path to the image file to create the preview/chaser task.
              Only used if start==end i.e.: a single frame render.
- is_anim (bool) - emit start, end, by args to the batch render command
- start (int) - the start frame for an animation sequence.
- end (int) - the end frame for an animation sequence.
- by (int) - by frame (or step) for an animation sequence.
- args (list) - other args to pass to maya batch

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.add_prman_render_task	(	parentTask,
		title,
		threads,
		rib,
		img,
		args = `[]`
	)

Create a single prman task for a Tractor job.

Args:
- parentTask (Task) - parent task that this prman task belongs to.
- title (str) - title to use for this task.
- threads (int) - number of threads to use for this prman task.
- rib (str) - full path to the RIB file to render.
- img (str) - full path to the image file that will be generated by the
              prman task. This is used to create the preview/chaser task.
- args (list) - other args to pass to prman

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.add_txmake_task	(	parentTask,
		title,
		args
	)

Create a single txmake task for Tractor job.

Args:
- parentTask (Task) - parent task that this txmake task belongs to.
- title (str) - title to use for this task.
- args (list) - txmake args including input and output name

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.batch_preview ( )

Generate a simple job file
and spool to LocalQueue, rendering to 'it'

Here is the call graph for this function:

def rfm2.spool.rfm_tractor.batch_render_spool ( do_bake = False )

Main entry point to start a spooled batch render job. Will spool
to either LocalQueue or Tractor, depending on the rfmRenderBatchQueue pref.

Here is the call graph for this function:

def rfm2.spool.rfm_tractor.generate_denoise_tasks	(	frametasktitle,
		frametask,
		displays,
		frame,
		start = `1`,
		end = `1`,
		by = `1`
	)

Create denoise tasks for a single frame for a Tractor job

Args:
- frametasktitle
- frametask (Task) - parent task that these denoise tasks belongs to.
- displays (dict) - displays dict
- frame (int) - the current frame
- start (int) - the starting frame of the sequence
- end (int) - the end frame of the sequence
- by (int) - how many frames to skip

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.generate_job_file	(	is_localqueue,
		scene,
		stash_scene_name,
		do_RIB,
		do_bake
	)

Generate a job file using the Tractor's Job Author API.

Args:
- is_localqueue (bool) - are we generating the job file for LocalQueue or not.
- scene (str) - the current scene name.
- stash_scene_name (str) - full path to the unique version of the scene file.
                         See 'stash_scene' function.
- do_RIB (bool) - controls whether to generate RIB for the scene.
- do_bake (bool) - controls whether to render using the bake hider,
                which runs PxrBakeTexture nodes in bake mode.

Returns:
- job (Job) - Tractor job instance. See 'Job Author Python API' in the
              Tractor documentation.
- jobfile (str) - Full path to the job file on disk.

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.generate_maya_batch_render_tasks	(	stash_scene_name,
		anim,
		parent_task,
		tasktitle,
		displays,
		beauty_dspy_variance,
		start,
		last,
		by,
		chunk,
		threads,
		do_bake,
		checkpoint
	)

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.generate_rib_render_tasks	(	is_localqueue,
		anim,
		parent_task,
		tasktitle,
		displays,
		beauty_dspy_variance,
		start,
		last,
		by,
		chunk,
		threads,
		do_bake,
		checkpoint
	)

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.generate_txmake_tasks ( )

Generate txmake tasks to be added to a job file

Returns
    - txmakeParentTask (Task): the parent task of all the txmake tasks

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.get_denoise_filtered_name ( s )

Try to ascertain what the filtered version of
the image filename will be after it has been denoised.

Args:
- s (str) - path to tokenized filename

Here is the caller graph for this function:

def rfm2.spool.rfm_tractor.register_tractor_prefs ( )

Register Tractor preferences.

Here is the call graph for this function:

def rfm2.spool.rfm_tractor.wait_for_txmanager ( mgr )

Wait for txmanager to finish its running tasks

Here is the call graph for this function:

Here is the caller graph for this function:

Functions

Function Documentation