<commit_before>[English](https://github.com/yamahigashi/SynopticGenerator/blob/master/README-en.md) / 
[Japanese](https://github.com/yamahigashi/SynopticGenerator/blob/master/README.md)


What is this?
======================

DCCc[(
[Autodesk Maya](http://www.autodesk.co.jp/products/autodesk-maya/overview)  
[Autodesk Softimage](http://www.autodesk.co.jp/products/autodesk-softimage/overview))p
ɃVmveBbNr[쐬XNvgłB  
̉摜t@CinAfARg[jƐݒt@CRg[̈
oVmveBbNiC[Wt@CA`t@CjɎdďグ܂B݂
Softimage p̏oɑΉĂ܂B

e푀 python module ƂēƗĎĂ̂ŁA@\̉ςǉAւ
eՂɍsƂł܂B

generate synoptic for dcc tool.


from Base image and Controllers image, config file to synoptic files (synthesised image and synoptic define text e.g. html)

How to use?
------
̓IȐ̓Tv̉QƂĂB

## 摜̏ ##
܂DCCc[Ȃǂ摜pӂ܂傤B

1. n摜pӂ܂
2. f摜pӂ܂iCӁj
3. Rg[摜pӂ܂

## ݒt@C̕ҏW ##
Lq sample.recipe QƂĂB

#### global ubN ####
e푀vOCfAQƂ邽߂̐ݒLq܂B  
O̐ݒFƐFl̑Ή\`Ȃǂł܂

#### pipeline ubN ####
̓IȏeAɋLqĂ

+ prepare: 摜̉HA
+ recognize: 摜̗̈撊o
+ filter: ̈f[^̉H
+ publish: ̈f[^̍ŏI摜`A`t@Co
+ finalize: ԃf[^폜Ȃǂ̑|

A̗ƂċLq܂Bpipeline ͔Cӂł

## 쐬XNvgs ##
ȉ python R[hs

    import synopticgenerator
    synopticgenerator.create("sample.recipe")


vOC
----------------

### image ###
摜t@C𑀍삷邽߂̃NXł

+ `image.set_transparent_by_color`
+ `image.paste_with_transparent`

### recognizer ###
摜t@C̈f[^𒊏o邽߂̃NXł

+ `recognizer.image_to_regions`

### filter ###
̈f[^𑀍삷邽߂̃NXł

+ `filter.uniq_region`
+ `filter.set_color_region`
+ `filter.naming_region_by_position`
+ `filter.copy_region`<commit_msg>Documented in English readme<commit_after>[English](https://github.com/yamahigashi/SynopticGenerator/blob/master/README-en.md) / 
[Japanese](https://github.com/yamahigashi/SynopticGenerator/blob/master/README.md)


What is this?
======================

For DCC tool(
[Autodesk maya](http://www.autodesk.co.jp/products/autodesk-maya/overview)  or
[Autodesk Softimage](http://www.autodesk.co.jp/products/autodesk-softimage/overview)),
generate synoptic image and view. From some image file (background, model and controllers)
and config file, detect controller's contours, synthesize them. Currently worknig for softimage.

Each operation is separated for python module, you can easyly modify, add new features.

How to use?
------
See sample for more informations.

## Preparation ##
from 

1. background image
2. model view image
3. controllers images

## Edit Configuration ##
See `sample/xsi_man/xsi_man.recipe` for more informations.


#### global block ####
You can set here configuration over modules,
for example, logging level and color table.

#### pipeline block ####
You descript here, each operations sequencially.

+ prepare: preparation for images
+ recognize: detect contours into region data
+ filter: filter regions data
+ publish: output synthesized image, view text file.
+ finalize: clean up

You can name pipeline's name as you want.

## Execution your script ##
Simply run this python code

    import synopticgenerator
    synopticgenerator.create("sample.recipe")


Plugin manual
----------------

### image ###
摜t@C𑀍삷邽߂̃NXł

+ `image.set_transparent_by_color`
+ `image.paste_with_transparent`

### recognizer ###
摜t@C̈f[^𒊏o邽߂̃NXł

+ `recognizer.image_to_regions`

### filter ###
̈f[^𑀍삷邽߂̃NXł

+ `filter.uniq_region`
+ `filter.set_color_region`
+ `filter.naming_region_by_position`
+ `filter.copy_region`
{'fraction_non_alphanumeric': 0.1589604110003022, 'fraction_numerical': 0.003928679359323058, 'mean_word_length': 4.868794326241135, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1007950', 'n_tokens_mistral': 1493, 'n_tokens_neox': 1448, 'n_words': 263}