VBUFFER

Burn vector into raster


EnvironmentsPYTHON :: EASI :: MODELER
Quick linksDescription :: Parameters :: Parameter descriptions :: Details :: Example

Back to top

Description


Burns an input vector segment into an existing raster channel and generates a new raster channel.
Back to top

Parameters


vbuffer(fili, dbic, filv, dbvs, filo, dboc, bufdist, burnval)

Name Type Caption Length Value range
FILI * str Input file name 1 -    
DBIC * List[int] Input raster channel 1 - 1  
FILV str Input vector file name 0 -    
DBVS * List[int] Input vector segment 1 - 1  
FILO str Output file name 0 -    
DBOC List[int] Output raster channel 0 - 1  
BUFDIST List[float] Buffer Width (m) 0 - 1 0 -
Default: 0.001
BURNVAL List[float] Buffer encoding image value 0 - 1 0 -
Default: 255.0

* Required parameter
Back to top

Parameter descriptions

FILI

Specifies the name of the PCIDSK file that contains the original raster image channel.

DBIC

Specifies the input channel onto which the vector will be burned.

FILV

Specifies the name of the GDB-format file that contains the vector segment. If this parameter is not specified, it is assumed that the vector segment is located in FILI.

DBVS

Specifies the vector segment to burn to the raster channel.

FILO

Specifies the name of the PCIDSK image file to receive the modified raster channel.

If the output file is not specified, it is assumed to be the same as FILI. If FILO is specified and already exists, its projection must be the same as FILI.

If FILO is specified but does not already exist, a new PCIDSK file is created. By default, the projection information from FILI is copied to the new FILO.

DBOC

Specifies the output channel to receive the generated output.

If the output file already exists, this parameter must be specified.

BUFDIST

Specifies the width of the buffer, in meters. The default value is 0.001.

BURNVAL

Specifies the value of the buffer encoding image. The default value is 255.0

Back to top

Details

VBUFFER burns a vector segment onto a raster channel, using a raster value specified by the BURNVAL (Buffer Encoding Image Value) parameter and a buffer width defined in meters by the BUFDIST (Buffer Width) parameter.

If the specified output file does not exist, a new output file is created. If an existing output file is specified, that file will be updated. If the output file is not specified, the results are written to the input file.

Back to top

Example

This example demonstrates the use of VBUFFER in generating a raster channel from an input raster channel and vector segment.

from pci.vbuffer import vbuffer

fili	=	"irvine.pix"	# input file
dbic	=	[1]	# input raster channel
filv	=	""	# same as input file
dbvs	=	[25]	# input vector segment
filo	=	"output.pix"	# output file name
dboc	=	[1]	# output raster channel
bufdist	=	[0.005]	# buffer width
burnval	=	[250.0]	# buffer encoding image value

vbuffer( fili, dbic, filv, dbvs, filo, dboc, bufdist, burnval )

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.